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

3 files changed, 263 insertions, 93 deletions

diff --git a/Nt32Pkg/WinNtBlockIoDxe/ComponentName.c b/Nt32Pkg/WinNtBlockIoDxe/ComponentName.c
index d18b0e2739..cad3d47029 100644
--- a/Nt32Pkg/WinNtBlockIoDxe/ComponentName.c
+++ b/Nt32Pkg/WinNtBlockIoDxe/ComponentName.c
@@ -26,6 +26,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

 WinNtBlockIoComponentNameGetDriverName (

@@ -34,6 +73,75 @@ WinNtBlockIoComponentNameGetDriverName (
   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

 WinNtBlockIoComponentNameGetControllerName (

@@ -44,20 +152,70 @@ WinNtBlockIoComponentNameGetControllerName (
   OUT CHAR16                                          **ControllerName

   );

 

+

 //

 // EFI Component Name Protocol

 //

-EFI_COMPONENT_NAME_PROTOCOL     gWinNtBlockIoComponentName = {

+EFI_COMPONENT_NAME_PROTOCOL  gWinNtBlockIoComponentName = {

   WinNtBlockIoComponentNameGetDriverName,

   WinNtBlockIoComponentNameGetControllerName,

   "eng"

-};

+  };

+

+//

+// EFI Component Name 2 Protocol

+//

+EFI_COMPONENT_NAME2_PROTOCOL gWinNtBlockIoComponentName2 = {

+  (EFI_COMPONENT_NAME2_GET_DRIVER_NAME) WinNtBlockIoComponentNameGetDriverName,

+  (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) WinNtBlockIoComponentNameGetControllerName,

+  "en"

+  };

+

 

 static EFI_UNICODE_STRING_TABLE mWinNtBlockIoDriverNameTable[] = {

-  { "eng", L"Windows Block I/O Driver" },

+  { "eng;en", L"Windows Block I/O 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

 WinNtBlockIoComponentNameGetDriverName (

@@ -65,41 +223,84 @@ WinNtBlockIoComponentNameGetDriverName (
   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,

-          gWinNtBlockIoComponentName.SupportedLanguages,

-          mWinNtBlockIoDriverNameTable,

-          DriverName

-          );

+  return LookupUnicodeString2 (

+           Language,

+           This->SupportedLanguages,

+           mWinNtBlockIoDriverNameTable,

+           DriverName,

+           (BOOLEAN)(This == &gWinNtBlockIoComponentName)

+           );

 }

 

+/**

+  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

 WinNtBlockIoComponentNameGetControllerName (

@@ -109,50 +310,6 @@ WinNtBlockIoComponentNameGetControllerName (
   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_BLOCK_IO_PROTOCOL   *BlockIo;

@@ -192,10 +349,11 @@ WinNtBlockIoComponentNameGetControllerName (
 

   Private = WIN_NT_BLOCK_IO_PRIVATE_DATA_FROM_THIS (BlockIo);

 

-  return LookupUnicodeString (

-          Language,

-          gWinNtBlockIoComponentName.SupportedLanguages,

-          Private->ControllerNameTable,

-          ControllerName

-          );

+  return LookupUnicodeString2 (

+           Language,

+           This->SupportedLanguages,

+           Private->ControllerNameTable,

+           ControllerName,

+           (BOOLEAN)(This == &gWinNtBlockIoComponentName)

+           );

 }

diff --git a/Nt32Pkg/WinNtBlockIoDxe/WinNtBlockIo.c b/Nt32Pkg/WinNtBlockIoDxe/WinNtBlockIo.c
index b294d5bda5..998fc5047d 100644
--- a/Nt32Pkg/WinNtBlockIoDxe/WinNtBlockIo.c
+++ b/Nt32Pkg/WinNtBlockIoDxe/WinNtBlockIo.c
@@ -110,14 +110,16 @@ InitializeWinNtBlockIo(
   //

   // Install driver model protocol(s).

   //

-  Status = EfiLibInstallAllDriverProtocols (

+  Status = EfiLibInstallAllDriverProtocols2 (

              ImageHandle,

              SystemTable,

              &gWinNtBlockIoDriverBinding,

              ImageHandle,

              &gWinNtBlockIoComponentName,

+             &gWinNtBlockIoComponentName2,

              NULL,

-             &gWinNtBlockIoDriverDiagnostics

+             &gWinNtBlockIoDriverDiagnostics,

+             NULL

              );

   ASSERT_EFI_ERROR (Status);

 

@@ -509,12 +511,21 @@ Returns:
 

   Private->ControllerNameTable  = NULL;

 

-  AddUnicodeString (

+  AddUnicodeString2 (

     "eng",

     gWinNtBlockIoComponentName.SupportedLanguages,

     &Private->ControllerNameTable,

-    Private->Filename

+    Private->Filename,

+    TRUE

     );

+  AddUnicodeString2 (

+    "en",

+    gWinNtBlockIoComponentName2.SupportedLanguages,

+    &Private->ControllerNameTable,

+    Private->Filename,

+    FALSE

+    );

+

 

   BlockIo = &Private->BlockIo;

   BlockIo->Revision = EFI_BLOCK_IO_PROTOCOL_REVISION;

diff --git a/Nt32Pkg/WinNtBlockIoDxe/WinNtBlockIo.h b/Nt32Pkg/WinNtBlockIoDxe/WinNtBlockIo.h
index f4ec37c098..313e25448c 100644
--- a/Nt32Pkg/WinNtBlockIoDxe/WinNtBlockIo.h
+++ b/Nt32Pkg/WinNtBlockIoDxe/WinNtBlockIo.h
@@ -94,10 +94,11 @@ typedef struct {
 //

 // Block I/O Global Variables

 //

-extern EFI_DRIVER_BINDING_PROTOCOL        gWinNtBlockIoDriverBinding;

-extern EFI_COMPONENT_NAME_PROTOCOL        gWinNtBlockIoComponentName;

-extern EFI_DRIVER_CONFIGURATION_PROTOCOL  gWinNtBlockIoDriverConfiguration;

-extern EFI_DRIVER_DIAGNOSTICS_PROTOCOL    gWinNtBlockIoDriverDiagnostics;

+extern EFI_DRIVER_BINDING_PROTOCOL         gWinNtBlockIoDriverBinding;

+extern EFI_COMPONENT_NAME_PROTOCOL         gWinNtBlockIoComponentName;

+extern EFI_COMPONENT_NAME2_PROTOCOL        gWinNtBlockIoComponentName2;

+extern EFI_DRIVER_CONFIGURATION_PROTOCOL   gWinNtBlockIoDriverConfiguration;

+extern EFI_DRIVER_DIAGNOSTICS_PROTOCOL     gWinNtBlockIoDriverDiagnostics;

 

 //

 // EFI Driver Binding Functions