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

1 files changed, 241 insertions, 90 deletions

diff --git a/MdeModulePkg/Universal/Network/Udp4Dxe/ComponentName.c b/MdeModulePkg/Universal/Network/Udp4Dxe/ComponentName.c
index b934765207..7fb1ce9bd7 100644
--- a/MdeModulePkg/Universal/Network/Udp4Dxe/ComponentName.c
+++ b/MdeModulePkg/Universal/Network/Udp4Dxe/ComponentName.c
@@ -24,6 +24,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

 UdpComponentNameGetDriverName (

@@ -32,28 +71,108 @@ UdpComponentNameGetDriverName (
   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

 UdpComponentNameGetControllerName (

-  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,

-  IN  EFI_HANDLE                   ControllerHandle,

-  IN  EFI_HANDLE                   ChildHandle OPTIONAL,

-  IN  CHAR8                        *Language,

-  OUT CHAR16                       **ControllerName

+  IN  EFI_COMPONENT_NAME_PROTOCOL                     *This,

+  IN  EFI_HANDLE                                      ControllerHandle,

+  IN  EFI_HANDLE                                      ChildHandle        OPTIONAL,

+  IN  CHAR8                                           *Language,

+  OUT CHAR16                                          **ControllerName

   );

 

+

 //

 // EFI Component Name Protocol

 //

-EFI_COMPONENT_NAME_PROTOCOL     gUdp4ComponentName = {

+EFI_COMPONENT_NAME_PROTOCOL  gUdp4ComponentName = {

   UdpComponentNameGetDriverName,

   UdpComponentNameGetControllerName,

   "eng"

-};

+  };

+

+//

+// EFI Component Name 2 Protocol

+//

+EFI_COMPONENT_NAME2_PROTOCOL gUdp4ComponentName2 = {

+  (EFI_COMPONENT_NAME2_GET_DRIVER_NAME) UdpComponentNameGetDriverName,

+  (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) UdpComponentNameGetControllerName,

+  "en"

+  };

+

 

 static EFI_UNICODE_STRING_TABLE mUdpDriverNameTable[] = {

   {

-    "eng",

+    "eng;en",

     L"UDP Network Service Driver"

   },

   {

@@ -62,6 +181,45 @@ static EFI_UNICODE_STRING_TABLE mUdpDriverNameTable[] = {
   }

 };

 

+/**

+  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

 UdpComponentNameGetDriverName (

@@ -69,100 +227,93 @@ UdpComponentNameGetDriverName (
   IN  CHAR8                        *Language,

   OUT CHAR16                       **DriverName

   )

-/*++

+{

+  return LookupUnicodeString2 (

+           Language,

+           This->SupportedLanguages,

+           mUdpDriverNameTable,

+           DriverName,

+           (BOOLEAN)(This == &gUdp4ComponentName)

+           );

+}

 

-Routine Description:

+/**

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

+  that is being managed by a driver.

 

-  Retrieves a Unicode string that is the user readable name of the EFI 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.

 

-Arguments:

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

+                                EFI_COMPONENT_NAME_PROTOCOL instance.

 

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

 

-Returns:

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

 

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

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

 

---*/

-{

-  return LookupUnicodeString (

-          Language,

-          gUdp4ComponentName.SupportedLanguages,

-          mUdpDriverNameTable,

-          DriverName

-          );

-}

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

 UdpComponentNameGetControllerName (

-  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,

-  IN  EFI_HANDLE                   ControllerHandle,

-  IN  EFI_HANDLE                   ChildHandle OPTIONAL,

-  IN  CHAR8                        *Language,

-  OUT CHAR16                       **ControllerName

+  IN  EFI_COMPONENT_NAME_PROTOCOL                     *This,

+  IN  EFI_HANDLE                                      ControllerHandle,

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

-

---*/

 {

   return EFI_UNSUPPORTED;

 }