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

4 files changed, 256 insertions, 174 deletions

diff --git a/IntelFrameworkModulePkg/Bus/Isa/IsaSerialDxe/ComponentName.c b/IntelFrameworkModulePkg/Bus/Isa/IsaSerialDxe/ComponentName.c
index 84423a8ba4..4534b53729 100644
--- a/IntelFrameworkModulePkg/Bus/Isa/IsaSerialDxe/ComponentName.c
+++ b/IntelFrameworkModulePkg/Bus/Isa/IsaSerialDxe/ComponentName.c
@@ -17,15 +17,25 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 //

 // EFI Component Name Protocol

 //

-EFI_COMPONENT_NAME_PROTOCOL     gIsaSerialComponentName = {

+EFI_COMPONENT_NAME_PROTOCOL  gIsaSerialComponentName = {

   IsaSerialComponentNameGetDriverName,

   IsaSerialComponentNameGetControllerName,

   "eng"

-};

+  };

+

+//

+// EFI Component Name 2 Protocol

+//

+EFI_COMPONENT_NAME2_PROTOCOL gIsaSerialComponentName2 = {

+  (EFI_COMPONENT_NAME2_GET_DRIVER_NAME) IsaSerialComponentNameGetDriverName,

+  (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) IsaSerialComponentNameGetControllerName,

+  "en"

+  };

+

 

 STATIC EFI_UNICODE_STRING_TABLE mIsaSerialDriverNameTable[] = {

   {

-    "eng",

+    "eng;en",

     L"ISA Serial Driver"

   },

   {

@@ -34,6 +44,45 @@ STATIC EFI_UNICODE_STRING_TABLE mIsaSerialDriverNameTable[] = {
   }

 };

 

+/**

+  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

 IsaSerialComponentNameGetDriverName (

@@ -41,44 +90,84 @@ IsaSerialComponentNameGetDriverName (
   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 (

+  return LookupUnicodeString2 (

            Language,

-           gIsaSerialComponentName.SupportedLanguages,

+           This->SupportedLanguages,

            mIsaSerialDriverNameTable,

-           DriverName

+           DriverName,

+           (BOOLEAN)(This == &gIsaSerialComponentName)

            );

 }

 

+/**

+  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

 IsaSerialComponentNameGetControllerName (

@@ -88,54 +177,6 @@ IsaSerialComponentNameGetControllerName (
   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_SERIAL_IO_PROTOCOL  *SerialIo;

@@ -177,11 +218,12 @@ IsaSerialComponentNameGetControllerName (
   //

   SerialDevice = SERIAL_DEV_FROM_THIS (SerialIo);

 

-  return LookupUnicodeString (

+  return LookupUnicodeString2 (

            Language,

-           gIsaSerialComponentName.SupportedLanguages,

+           This->SupportedLanguages,

            SerialDevice->ControllerNameTable,

-           ControllerName

+           ControllerName,

+           (BOOLEAN)(This == &gIsaSerialComponentName)

            );

 }

 

@@ -211,10 +253,19 @@ AddName (
 

   StrCpy (SerialPortName, L"ISA Serial Port # ");

   SerialPortName[sizeof (SERIAL_PORT_NAME) - 2] = (CHAR16) (L'0' + (UINT8) IsaIo->ResourceList->Device.UID);

-  AddUnicodeString (

+  AddUnicodeString2 (

     "eng",

     gIsaSerialComponentName.SupportedLanguages,

     &SerialDevice->ControllerNameTable,

-    (CHAR16 *) SerialPortName

+    (CHAR16 *) SerialPortName,

+    TRUE

     );

+  AddUnicodeString2 (

+    "en",

+    gIsaSerialComponentName2.SupportedLanguages,

+    &SerialDevice->ControllerNameTable,

+    (CHAR16 *) SerialPortName,

+    FALSE

+    );

+

 }

diff --git a/IntelFrameworkModulePkg/Bus/Isa/IsaSerialDxe/ComponentName.h b/IntelFrameworkModulePkg/Bus/Isa/IsaSerialDxe/ComponentName.h
index 51c928ed20..cd81921687 100644
--- a/IntelFrameworkModulePkg/Bus/Isa/IsaSerialDxe/ComponentName.h
+++ b/IntelFrameworkModulePkg/Bus/Isa/IsaSerialDxe/ComponentName.h
@@ -18,49 +18,128 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #define SERIAL_PORT_NAME  "ISA Serial Port # "

 #define ADD_SERIAL_NAME(x, y)    AddName ((x), (y))

 

-extern EFI_COMPONENT_NAME_PROTOCOL  gIsaSerialComponentName;

+extern EFI_COMPONENT_NAME_PROTOCOL   gIsaSerialComponentName;

+extern EFI_COMPONENT_NAME2_PROTOCOL  gIsaSerialComponentName2;

 

 //

 // EFI Component Name Functions

 //

-EFI_STATUS

-EFIAPI

-IsaSerialComponentNameGetDriverName (

-  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,

-  IN  CHAR8                        *Language,

-  OUT CHAR16                       **DriverName

-  )

-/*++

+/**

+  Retrieves a Unicode string that is the user readable name of the driver.

 

-  Routine Description:

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

 

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

+  @param  This[in]              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or

+                                EFI_COMPONENT_NAME_PROTOCOL instance.

 

-  Arguments:

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

 

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

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

 

-  Returns:

+  @retval EFI_SUCCESS           The Unicode string for the Driver specified by

+                                This and the language specified by Language was

+                                returned in DriverName.

 

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

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

+IsaSerialComponentNameGetDriverName (

+  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,

+  IN  CHAR8                        *Language,

+  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

 IsaSerialComponentNameGetControllerName (

@@ -69,56 +148,8 @@ IsaSerialComponentNameGetControllerName (
   IN  EFI_HANDLE                                      ChildHandle        OPTIONAL,

   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.

-

---*/

-;

 

 VOID

 AddName (

diff --git a/IntelFrameworkModulePkg/Bus/Isa/IsaSerialDxe/Serial.c b/IntelFrameworkModulePkg/Bus/Isa/IsaSerialDxe/Serial.c
index 846d863c30..134b0fd8a8 100644
--- a/IntelFrameworkModulePkg/Bus/Isa/IsaSerialDxe/Serial.c
+++ b/IntelFrameworkModulePkg/Bus/Isa/IsaSerialDxe/Serial.c
@@ -108,14 +108,13 @@ InitializeIsaSerial (
   //

   // Install driver model protocol(s).

   //

-  Status = EfiLibInstallAllDriverProtocols (

+  Status = EfiLibInstallDriverBindingComponentName2 (

              ImageHandle,

              SystemTable,

              &gSerialControllerDriver,

              ImageHandle,

              &gIsaSerialComponentName,

-             NULL,

-             NULL

+             &gIsaSerialComponentName2

              );

   ASSERT_EFI_ERROR (Status);

 

diff --git a/IntelFrameworkModulePkg/Bus/Isa/IsaSerialDxe/Serial.h b/IntelFrameworkModulePkg/Bus/Isa/IsaSerialDxe/Serial.h
index 0fcc4f3fb0..980e0d17c2 100644
--- a/IntelFrameworkModulePkg/Bus/Isa/IsaSerialDxe/Serial.h
+++ b/IntelFrameworkModulePkg/Bus/Isa/IsaSerialDxe/Serial.h
@@ -36,8 +36,9 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 //

 // Driver Binding Externs

 //

-extern EFI_DRIVER_BINDING_PROTOCOL gSerialControllerDriver;

-extern EFI_COMPONENT_NAME_PROTOCOL gIsaSerialComponentName;

+extern EFI_DRIVER_BINDING_PROTOCOL  gSerialControllerDriver;

+extern EFI_COMPONENT_NAME_PROTOCOL  gIsaSerialComponentName;

+extern EFI_COMPONENT_NAME2_PROTOCOL gIsaSerialComponentName2;

 

 //

 // Internal Data Structures

@@ -116,7 +117,7 @@ typedef struct {
 //

 // Globale Variables

 //

-extern EFI_DRIVER_BINDING_PROTOCOL  gSerialControllerDriver;

+extern EFI_DRIVER_BINDING_PROTOCOL   gSerialControllerDriver;

 

 //

 // Serial Driver Defaults