Update to support to produce Component Name and & Component Name 2 protocol based...

[mirror_edk2.git] / MdeModulePkg / Universal / Network / Tcp4Dxe / ComponentName.c

diff --git a/MdeModulePkg/Universal/Network/Tcp4Dxe/ComponentName.c b/MdeModulePkg/Universal/Network/Tcp4Dxe/ComponentName.c
index 477af22e1e65a16288a32a0662cee088de8562b6..fae269fa16b24fcc9b999b52bf9ebbf7fc0937c4 100644 (file)
--- a/MdeModulePkg/Universal/Network/Tcp4Dxe/ComponentName.c
+++ b/MdeModulePkg/Universal/Network/Tcp4Dxe/ComponentName.c
@@ -23,6 +23,45 @@ Abstract:
 //\r
 // EFI Component Name Functions\r
 //\r
 //\r
 // EFI Component Name Functions\r
 //\r

+/**\r
+  Retrieves a Unicode string that is the user readable name of the driver.\r
+\r
+  This function retrieves the user readable name of a driver in the form of a\r
+  Unicode string. If the driver specified by This has a user readable name in\r
+  the language specified by Language, then a pointer to the driver name is\r
+  returned in DriverName, and EFI_SUCCESS is returned. If the driver specified\r
+  by This does not support the language specified by Language,\r
+  then EFI_UNSUPPORTED is returned.\r
+\r
+  @param  This[in]              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
+                                EFI_COMPONENT_NAME_PROTOCOL instance.\r
+\r
+  @param  Language[in]          A pointer to a Null-terminated ASCII string\r
+                                array indicating the language. This is the\r
+                                language of the driver name that the caller is\r
+                                requesting, and it must match one of the\r
+                                languages specified in SupportedLanguages. The\r
+                                number of languages supported by a driver is up\r
+                                to the driver writer. Language is specified\r
+                                in RFC 3066 or ISO 639-2 language code format.\r
+\r
+  @param  DriverName[out]       A pointer to the Unicode string to return.\r
+                                This Unicode string is the name of the\r
+                                driver specified by This in the language\r
+                                specified by Language.\r
+\r
+  @retval EFI_SUCCESS           The Unicode string for the Driver specified by\r
+                                This and the language specified by Language was\r
+                                returned in DriverName.\r
+\r
+  @retval EFI_INVALID_PARAMETER Language is NULL.\r
+\r
+  @retval EFI_INVALID_PARAMETER DriverName is NULL.\r
+\r
+  @retval EFI_UNSUPPORTED       The driver specified by This does not support\r
+                                the language specified by Language.\r
+\r
+**/\r

 EFI_STATUS\r
 EFIAPI\r
 TcpComponentNameGetDriverName (\r
 EFI_STATUS\r
 EFIAPI\r
 TcpComponentNameGetDriverName (\r


@@ -31,28 +70,108 @@ TcpComponentNameGetDriverName (
   OUT CHAR16                       **DriverName\r
   );\r
 \r
   OUT CHAR16                       **DriverName\r
   );\r
 \r

+\r
+/**\r
+  Retrieves a Unicode string that is the user readable name of the controller\r
+  that is being managed by a driver.\r
+\r
+  This function retrieves the user readable name of the controller specified by\r
+  ControllerHandle and ChildHandle in the form of a Unicode string. If the\r
+  driver specified by This has a user readable name in the language specified by\r
+  Language, then a pointer to the controller name is returned in ControllerName,\r
+  and EFI_SUCCESS is returned.  If the driver specified by This is not currently\r
+  managing the controller specified by ControllerHandle and ChildHandle,\r
+  then EFI_UNSUPPORTED is returned.  If the driver specified by This does not\r
+  support the language specified by Language, then EFI_UNSUPPORTED is returned.\r
+\r
+  @param  This[in]              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
+                                EFI_COMPONENT_NAME_PROTOCOL instance.\r
+\r
+  @param  ControllerHandle[in]  The handle of a controller that the driver\r
+                                specified by This is managing.  This handle\r
+                                specifies the controller whose name is to be\r
+                                returned.\r
+\r
+  @param  ChildHandle[in]       The handle of the child controller to retrieve\r
+                                the name of.  This is an optional parameter that\r
+                                may be NULL.  It will be NULL for device\r
+                                drivers.  It will also be NULL for a bus drivers\r
+                                that wish to retrieve the name of the bus\r
+                                controller.  It will not be NULL for a bus\r
+                                driver that wishes to retrieve the name of a\r
+                                child controller.\r
+\r
+  @param  Language[in]          A pointer to a Null-terminated ASCII string\r
+                                array indicating the language.  This is the\r
+                                language of the driver name that the caller is\r
+                                requesting, and it must match one of the\r
+                                languages specified in SupportedLanguages. The\r
+                                number of languages supported by a driver is up\r
+                                to the driver writer. Language is specified in\r
+                                RFC 3066 or ISO 639-2 language code format.\r
+\r
+  @param  ControllerName[out]   A pointer to the Unicode string to return.\r
+                                This Unicode string is the name of the\r
+                                controller specified by ControllerHandle and\r
+                                ChildHandle in the language specified by\r
+                                Language from the point of view of the driver\r
+                                specified by This.\r
+\r
+  @retval EFI_SUCCESS           The Unicode string for the user readable name in\r
+                                the language specified by Language for the\r
+                                driver specified by This was returned in\r
+                                DriverName.\r
+\r
+  @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.\r
+\r
+  @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid\r
+                                EFI_HANDLE.\r
+\r
+  @retval EFI_INVALID_PARAMETER Language is NULL.\r
+\r
+  @retval EFI_INVALID_PARAMETER ControllerName is NULL.\r
+\r
+  @retval EFI_UNSUPPORTED       The driver specified by This is not currently\r
+                                managing the controller specified by\r
+                                ControllerHandle and ChildHandle.\r
+\r
+  @retval EFI_UNSUPPORTED       The driver specified by This does not support\r
+                                the language specified by Language.\r
+\r
+**/\r

 EFI_STATUS\r
 EFIAPI\r
 TcpComponentNameGetControllerName (\r
 EFI_STATUS\r
 EFIAPI\r
 TcpComponentNameGetControllerName (\r

-  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,\r
-  IN  EFI_HANDLE                   ControllerHandle,\r
-  IN  EFI_HANDLE                   ChildHandle  OPTIONAL,\r
-  IN  CHAR8                        *Language,\r
-  OUT CHAR16                       **ControllerName\r
+  IN  EFI_COMPONENT_NAME_PROTOCOL                     *This,\r
+  IN  EFI_HANDLE                                      ControllerHandle,\r
+  IN  EFI_HANDLE                                      ChildHandle        OPTIONAL,\r
+  IN  CHAR8                                           *Language,\r
+  OUT CHAR16                                          **ControllerName\r

   );\r
 \r
   );\r
 \r

+\r

 //\r
 // EFI Component Name Protocol\r
 //\r
 //\r
 // EFI Component Name Protocol\r
 //\r

-EFI_COMPONENT_NAME_PROTOCOL     gTcp4ComponentName = {\r
+EFI_COMPONENT_NAME_PROTOCOL  gTcp4ComponentName = {\r

   TcpComponentNameGetDriverName,\r
   TcpComponentNameGetControllerName,\r
   "eng"\r
   TcpComponentNameGetDriverName,\r
   TcpComponentNameGetControllerName,\r
   "eng"\r

-};\r
+  };\r
+\r
+//\r
+// EFI Component Name 2 Protocol\r
+//\r
+EFI_COMPONENT_NAME2_PROTOCOL gTcp4ComponentName2 = {\r
+  (EFI_COMPONENT_NAME2_GET_DRIVER_NAME) TcpComponentNameGetDriverName,\r
+  (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) TcpComponentNameGetControllerName,\r
+  "en"\r
+  };\r
+\r

 \r
 static EFI_UNICODE_STRING_TABLE mTcpDriverNameTable[] = {\r
   {\r
 \r
 static EFI_UNICODE_STRING_TABLE mTcpDriverNameTable[] = {\r
   {\r

-    "eng",\r
+    "eng;en",\r

     L"Tcp Network Service Driver"\r
   },\r
   {\r
     L"Tcp Network Service Driver"\r
   },\r
   {\r


@@ -61,6 +180,45 @@ static EFI_UNICODE_STRING_TABLE mTcpDriverNameTable[] = {
   }\r
 };\r
 \r
   }\r
 };\r
 \r

+/**\r
+  Retrieves a Unicode string that is the user readable name of the driver.\r
+\r
+  This function retrieves the user readable name of a driver in the form of a\r
+  Unicode string. If the driver specified by This has a user readable name in\r
+  the language specified by Language, then a pointer to the driver name is\r
+  returned in DriverName, and EFI_SUCCESS is returned. If the driver specified\r
+  by This does not support the language specified by Language,\r
+  then EFI_UNSUPPORTED is returned.\r
+\r
+  @param  This[in]              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
+                                EFI_COMPONENT_NAME_PROTOCOL instance.\r
+\r
+  @param  Language[in]          A pointer to a Null-terminated ASCII string\r
+                                array indicating the language. This is the\r
+                                language of the driver name that the caller is\r
+                                requesting, and it must match one of the\r
+                                languages specified in SupportedLanguages. The\r
+                                number of languages supported by a driver is up\r
+                                to the driver writer. Language is specified\r
+                                in RFC 3066 or ISO 639-2 language code format.\r
+\r
+  @param  DriverName[out]       A pointer to the Unicode string to return.\r
+                                This Unicode string is the name of the\r
+                                driver specified by This in the language\r
+                                specified by Language.\r
+\r
+  @retval EFI_SUCCESS           The Unicode string for the Driver specified by\r
+                                This and the language specified by Language was\r
+                                returned in DriverName.\r
+\r
+  @retval EFI_INVALID_PARAMETER Language is NULL.\r
+\r
+  @retval EFI_INVALID_PARAMETER DriverName is NULL.\r
+\r
+  @retval EFI_UNSUPPORTED       The driver specified by This does not support\r
+                                the language specified by Language.\r
+\r
+**/\r

 EFI_STATUS\r
 EFIAPI\r
 TcpComponentNameGetDriverName (\r
 EFI_STATUS\r
 EFIAPI\r
 TcpComponentNameGetDriverName (\r


@@ -68,102 +226,93 @@ TcpComponentNameGetDriverName (
   IN  CHAR8                        *Language,\r
   OUT CHAR16                       **DriverName\r
   )\r
   IN  CHAR8                        *Language,\r
   OUT CHAR16                       **DriverName\r
   )\r

-/*++\r
+{\r
+  return LookupUnicodeString2 (\r
+           Language,\r
+           This->SupportedLanguages,\r
+           mTcpDriverNameTable,\r
+           DriverName,\r
+           (BOOLEAN)(This == &gTcp4ComponentName)\r
+           );\r
+}\r

 \r
 \r

-Routine Description:\r
+/**\r
+  Retrieves a Unicode string that is the user readable name of the controller\r
+  that is being managed by a driver.\r

 \r
 \r

-  Retrieves a Unicode string that is the user readable name of the EFI Driver.\r
+  This function retrieves the user readable name of the controller specified by\r
+  ControllerHandle and ChildHandle in the form of a Unicode string. If the\r
+  driver specified by This has a user readable name in the language specified by\r
+  Language, then a pointer to the controller name is returned in ControllerName,\r
+  and EFI_SUCCESS is returned.  If the driver specified by This is not currently\r
+  managing the controller specified by ControllerHandle and ChildHandle,\r
+  then EFI_UNSUPPORTED is returned.  If the driver specified by This does not\r
+  support the language specified by Language, then EFI_UNSUPPORTED is returned.\r

 \r
 \r

-Arguments:\r
+  @param  This[in]              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
+                                EFI_COMPONENT_NAME_PROTOCOL instance.\r

 \r
 \r

-  This       - A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.\r
-  Language   - A pointer to a three character ISO 639-2 language identifier.\r
-               This is the language of the driver name that that the caller\r
-               is requesting, and it must match one of the languages\r
-               specified in SupportedLanguages.  The number of languages\r
-               supported by a driver is up to the driver writer.\r
-  DriverName - A pointer to the Unicode string to return.  This Unicode\r
-               string is the name of the driver specified by This in the\r
-               language specified by Language.\r
+  @param  ControllerHandle[in]  The handle of a controller that the driver\r
+                                specified by This is managing.  This handle\r
+                                specifies the controller whose name is to be\r
+                                returned.\r

 \r
 \r

-Returns:\r
+  @param  ChildHandle[in]       The handle of the child controller to retrieve\r
+                                the name of.  This is an optional parameter that\r
+                                may be NULL.  It will be NULL for device\r
+                                drivers.  It will also be NULL for a bus drivers\r
+                                that wish to retrieve the name of the bus\r
+                                controller.  It will not be NULL for a bus\r
+                                driver that wishes to retrieve the name of a\r
+                                child controller.\r

 \r
 \r

-  EFI_SUCCES            - The Unicode string for the Driver specified by\r
-                          This and the language specified by Language was\r
-                          returned in DriverName.\r
-  EFI_INVALID_PARAMETER - Language is NULL.\r
-  EFI_INVALID_PARAMETER - DriverName is NULL.\r
-  EFI_UNSUPPORTED       - The driver specified by This does not support the\r
-                          language specified by Language.\r
+  @param  Language[in]          A pointer to a Null-terminated ASCII string\r
+                                array indicating the language.  This is the\r
+                                language of the driver name that the caller is\r
+                                requesting, and it must match one of the\r
+                                languages specified in SupportedLanguages. The\r
+                                number of languages supported by a driver is up\r
+                                to the driver writer. Language is specified in\r
+                                RFC 3066 or ISO 639-2 language code format.\r

 \r
 \r

---*/\r
-{\r
-  return LookupUnicodeString (\r
-          Language,\r
-          gTcp4ComponentName.SupportedLanguages,\r
-          mTcpDriverNameTable,\r
-          DriverName\r
-          );\r
-}\r
+  @param  ControllerName[out]   A pointer to the Unicode string to return.\r
+                                This Unicode string is the name of the\r
+                                controller specified by ControllerHandle and\r
+                                ChildHandle in the language specified by\r
+                                Language from the point of view of the driver\r
+                                specified by This.\r
+\r
+  @retval EFI_SUCCESS           The Unicode string for the user readable name in\r
+                                the language specified by Language for the\r
+                                driver specified by This was returned in\r
+                                DriverName.\r
+\r
+  @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.\r
+\r
+  @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid\r
+                                EFI_HANDLE.\r
+\r
+  @retval EFI_INVALID_PARAMETER Language is NULL.\r
+\r
+  @retval EFI_INVALID_PARAMETER ControllerName is NULL.\r
+\r
+  @retval EFI_UNSUPPORTED       The driver specified by This is not currently\r
+                                managing the controller specified by\r
+                                ControllerHandle and ChildHandle.\r

 \r
 \r

+  @retval EFI_UNSUPPORTED       The driver specified by This does not support\r
+                                the language specified by Language.\r
+\r
+**/\r

 EFI_STATUS\r
 EFIAPI\r
 TcpComponentNameGetControllerName (\r
 EFI_STATUS\r
 EFIAPI\r
 TcpComponentNameGetControllerName (\r

-  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,\r
-  IN  EFI_HANDLE                   ControllerHandle,\r
-  IN  EFI_HANDLE                   ChildHandle  OPTIONAL,\r
-  IN  CHAR8                        *Language,\r
-  OUT CHAR16                       **ControllerName\r
+  IN  EFI_COMPONENT_NAME_PROTOCOL                     *This,\r
+  IN  EFI_HANDLE                                      ControllerHandle,\r
+  IN  EFI_HANDLE                                      ChildHandle        OPTIONAL,\r
+  IN  CHAR8                                           *Language,\r
+  OUT CHAR16                                          **ControllerName\r

   )\r
   )\r

-/*++\r
-\r
-Routine Description:\r
-\r
-  Retrieves a Unicode string that is the user readable name of the controller\r
-  that is being managed by an EFI Driver.\r
-\r
-Arguments:\r
-\r
-  This             - A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.\r
-  ControllerHandle - The handle of a controller that the driver specified by\r
-                     This is managing.  This handle specifies the controller\r
-                     whose name is to be returned.\r
-  ChildHandle      - The handle of the child controller to retrieve the name\r
-                     of.  This is an optional parameter that may be NULL.\r
-                     It will be NULL for device drivers.  It will also be\r
-                     NULL for a bus drivers that wish to retrieve the name of\r
-                     the bus controller.  It will not be NULL for a bus\r
-                     driver that wishes to retrieve the name of a child\r
-                     controller.\r
-  Language         - A pointer to a three character ISO 639-2 language\r
-                     identifier.  This is the language of the controller\r
-                     name that that the caller is requesting, and it must\r
-                     match one of the languages specified in supported\r
-                     languages. The number of languages supported by a driver\r
-                     is up to the driver writer.\r
-  ControllerName   - A pointer to the Unicode string to return.  This Unicode\r
-                     string is the name of the controller specified by\r
-                     ControllerHandle and ChildHandle in the language\r
-                     specified by Language from the point of view of the\r
-                     driver specified by This.\r
-\r
-Returns:\r
-\r
-  EFI_SUCCESS           - The Unicode string for the user readable name in\r
-                          the language specified by Language for the driver\r
-                          specified by This was returned in DriverName.\r
-  EFI_INVALID_PARAMETER - ControllerHandle is not a valid EFI_HANDLE.\r
-  EFI_INVALID_PARAMETER - ChildHandle is not NULL and it is not a valid\r
-                          EFI_HANDLE.\r
-  EFI_INVALID_PARAMETER - Language is NULL.\r
-  EFI_INVALID_PARAMETER - ControllerName is NULL.\r
-  EFI_UNSUPPORTED       - The driver specified by This is not currently\r
-                          managing the controller specified by\r
-                          ControllerHandle and ChildHandle.\r
-  EFI_UNSUPPORTED       - The driver specified by This does not support the\r
-                          language specified by Language.\r
-\r
---*/\r

 {\r
   return EFI_UNSUPPORTED;\r
 }\r
 {\r
   return EFI_UNSUPPORTED;\r
 }\r