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@3989 6f19259b-4bc3-4df7-8a09-765794883524

3 files changed, 270 insertions, 94 deletions

diff --git a/Nt32Pkg/WinNtBusDriverDxe/ComponentName.c b/Nt32Pkg/WinNtBusDriverDxe/ComponentName.c
index c0ea6e853b..b9efc82584 100644
--- a/Nt32Pkg/WinNtBusDriverDxe/ComponentName.c
+++ b/Nt32Pkg/WinNtBusDriverDxe/ComponentName.c
@@ -37,6 +37,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

 WinNtBusDriverComponentNameGetDriverName (

@@ -45,6 +84,75 @@ WinNtBusDriverComponentNameGetDriverName (
   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

 WinNtBusDriverComponentNameGetControllerName (

@@ -55,20 +163,70 @@ WinNtBusDriverComponentNameGetControllerName (
   OUT CHAR16                                          **ControllerName

   );

 

+

 //

 // EFI Component Name Protocol

 //

-EFI_COMPONENT_NAME_PROTOCOL     gWinNtBusDriverComponentName = {

+EFI_COMPONENT_NAME_PROTOCOL  gWinNtBusDriverComponentName = {

   WinNtBusDriverComponentNameGetDriverName,

   WinNtBusDriverComponentNameGetControllerName,

   "eng"

-};

+  };

+

+//

+// EFI Component Name 2 Protocol

+//

+EFI_COMPONENT_NAME2_PROTOCOL gWinNtBusDriverComponentName2 = {

+  (EFI_COMPONENT_NAME2_GET_DRIVER_NAME) WinNtBusDriverComponentNameGetDriverName,

+  (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) WinNtBusDriverComponentNameGetControllerName,

+  "en"

+  };

+

 

 static EFI_UNICODE_STRING_TABLE mWinNtBusDriverNameTable[] = {

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

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

   { NULL , NULL }

 };

 

+/**

+  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

 WinNtBusDriverComponentNameGetDriverName (

@@ -76,41 +234,84 @@ WinNtBusDriverComponentNameGetDriverName (
   IN  CHAR8                        *Language,

   OUT CHAR16                       **DriverName

   )

-/*++

-

-  Routine Description:

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

-

-  Arguments:

-    This       - A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.

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

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

-

-  Returns:

-    EFI_SUCCESS           - The Unicode string for the Driver specified by This

-                            and the language specified by Language was returned 

-                            in DriverName.

-    EFI_INVALID_PARAMETER - Language is NULL.

-    EFI_INVALID_PARAMETER - DriverName is NULL.

-    EFI_UNSUPPORTED       - The driver specified by This does not support the 

-                            language specified by Language.

-

---*/

 {

-  return LookupUnicodeString (

-          Language,

-          gWinNtBusDriverComponentName.SupportedLanguages,

-          mWinNtBusDriverNameTable,

-          DriverName

-          );

+  return LookupUnicodeString2 (

+           Language,

+           This->SupportedLanguages,

+           mWinNtBusDriverNameTable,

+           DriverName,

+           (BOOLEAN)(This == &gWinNtBusDriverComponentName)

+           );

 }

 

+/**

+  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

 WinNtBusDriverComponentNameGetControllerName (

@@ -120,50 +321,6 @@ WinNtBusDriverComponentNameGetControllerName (
   IN  CHAR8                                           *Language,

   OUT CHAR16                                          **ControllerName

   )

-/*++

-

-  Routine Description:

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

-    that is being managed by an EFI Driver.

-

-  Arguments:

-    This             - A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.

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

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

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

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

-

-  Returns:

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

-    EFI_INVALID_PARAMETER - ControllerHandle is not a valid EFI_HANDLE.

-    EFI_INVALID_PARAMETER - ChildHandle is not NULL and it is not a valid EFI_HANDLE.

-    EFI_INVALID_PARAMETER - Language is NULL.

-    EFI_INVALID_PARAMETER - ControllerName is NULL.

-    EFI_UNSUPPORTED       - The driver specified by This is not currently managing 

-                            the controller specified by ControllerHandle and 

-                            ChildHandle.

-    EFI_UNSUPPORTED       - The driver specified by This does not support the 

-                            language specified by Language.

-

---*/

 {

   EFI_STATUS              Status;

   EFI_WIN_NT_IO_PROTOCOL  *WinNtIo;

@@ -214,10 +371,11 @@ WinNtBusDriverComponentNameGetControllerName (
 

   Private = WIN_NT_IO_DEVICE_FROM_THIS (WinNtIo);

 

-  return LookupUnicodeString (

-          Language,

-          gWinNtBusDriverComponentName.SupportedLanguages,

-          Private->ControllerNameTable,

-          ControllerName

-          );

+  return LookupUnicodeString2 (

+           Language,

+           This->SupportedLanguages,

+           Private->ControllerNameTable,

+           ControllerName,

+           (BOOLEAN)(This == &gWinNtBusDriverComponentName)

+           );

 }

diff --git a/Nt32Pkg/WinNtBusDriverDxe/WinNtBusDriver.c b/Nt32Pkg/WinNtBusDriverDxe/WinNtBusDriver.c
index edcd9eb96d..932f7edb67 100644
--- a/Nt32Pkg/WinNtBusDriverDxe/WinNtBusDriver.c
+++ b/Nt32Pkg/WinNtBusDriverDxe/WinNtBusDriver.c
@@ -175,14 +175,13 @@ InitializeWinNtBusDriver(
   //

   // Install driver model protocol(s).

   //

-  Status = EfiLibInstallAllDriverProtocols (

+  Status = EfiLibInstallDriverBindingComponentName2 (

              ImageHandle,

              SystemTable,

              &gWinNtBusDriverBinding,

              ImageHandle,

              &gWinNtBusDriverComponentName,

-             NULL,

-             NULL

+             &gWinNtBusDriverComponentName2

              );

   ASSERT_EFI_ERROR (Status);

 

@@ -401,12 +400,21 @@ Returns:
     WinNtBusDevice->Signature           = WIN_NT_BUS_DEVICE_SIGNATURE;

     WinNtBusDevice->ControllerNameTable = NULL;

 

-    AddUnicodeString (

+    AddUnicodeString2 (

       "eng",

       gWinNtBusDriverComponentName.SupportedLanguages,

       &WinNtBusDevice->ControllerNameTable,

-      L"Windows Bus Controller"

+      L"Windows Bus Controller",

+      TRUE

       );

+    AddUnicodeString2 (

+      "en",

+      gWinNtBusDriverComponentName2.SupportedLanguages,

+      &WinNtBusDevice->ControllerNameTable,

+      L"Windows Bus Controller",

+      FALSE

+      );

+

 

     Status = gBS->InstallMultipleProtocolInterfaces (

                     &ControllerHandle,

@@ -516,12 +524,21 @@ Returns:
           return EFI_OUT_OF_RESOURCES;

         }

 

-        AddUnicodeString (

+        AddUnicodeString2 (

           "eng",

           gWinNtBusDriverComponentName.SupportedLanguages,

           &WinNtDevice->ControllerNameTable,

-          ComponentName

+          ComponentName,

+          TRUE

           );

+        AddUnicodeString2 (

+          "en",

+          gWinNtBusDriverComponentName2.SupportedLanguages,

+          &WinNtDevice->ControllerNameTable,

+          ComponentName,

+          FALSE

+          );

+

 

         WinNtDevice->WinNtIo.TypeGuid       = mPcdEnvironment[Index].DevicePathGuid;

         WinNtDevice->WinNtIo.InstanceNumber = Count;

diff --git a/Nt32Pkg/WinNtBusDriverDxe/WinNtBusDriver.h b/Nt32Pkg/WinNtBusDriverDxe/WinNtBusDriver.h
index ec3e22770b..b2a009bf0f 100644
--- a/Nt32Pkg/WinNtBusDriverDxe/WinNtBusDriver.h
+++ b/Nt32Pkg/WinNtBusDriverDxe/WinNtBusDriver.h
@@ -131,8 +131,9 @@ EFI_WIN_NT_PASS_THRU      - associates a device with our PCI support
 //

 // WinNt Bus Driver Global Variables

 //

-extern EFI_DRIVER_BINDING_PROTOCOL  gWinNtBusDriverBinding;

-extern EFI_COMPONENT_NAME_PROTOCOL  gWinNtBusDriverComponentName;

+extern EFI_DRIVER_BINDING_PROTOCOL   gWinNtBusDriverBinding;

+extern EFI_COMPONENT_NAME_PROTOCOL   gWinNtBusDriverComponentName;

+extern EFI_COMPONENT_NAME2_PROTOCOL  gWinNtBusDriverComponentName2;

 

 //

 // WinNt Bus Controller Structure