RedfishPkg: add Component Name protocols to RedfishConfigHandler driver

Currently there is no description for RedfishConfigHandler driver.
This leads to <null string> in the "DRIVER NAME" column of a `drivers`
command for example.

Cc: Nickle Wang <nicklew@nvidia.com>
Cc: Igor Kulchytskyy <igork@ami.com>
Signed-off-by: Mike Maslenkin <mike.maslenkin@gmail.com>
Reviewed-by: Abner Chang <abner.chang@amd.com>

4 files changed, 230 insertions, 3 deletions

diff --git a/RedfishPkg/RedfishConfigHandler/ComponentName.c b/RedfishPkg/RedfishConfigHandler/ComponentName.c
new file mode 100644
index 0000000000..8e19fdb2cd
--- /dev/null
+++ b/RedfishPkg/RedfishConfigHandler/ComponentName.c
@@ -0,0 +1,218 @@
+/** @file

+  Implementation of EFI_COMPONENT_NAME_PROTOCOL and EFI_COMPONENT_NAME2_PROTOCOL protocol

+  for EFI Refish Config Handler Protocol

+

+  Copyright (c) 2023, Mike Maslenkin <mike.maslenkin@gmail.com> <BR>

+

+  SPDX-License-Identifier: BSD-2-Clause-Patent

+

+**/

+

+#include "RedfishConfigHandlerCommon.h"

+

+//

+// EFI Component Name Functions

+//

+

+/**

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

+

+  @param[in]  This       A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.

+  @param[in]  Language   A pointer to a three-character ISO 639-2 language identifier.

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

+  @param[out] 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.

+

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

+RedfishConfigHandlerComponentNameGetDriverName (

+  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 an EFI Driver.

+

+  @param[in]  This             A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.

+  @param[in]  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.

+  @param[in]  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.

+  @param[in]  Language         A pointer to a three character ISO 639-2 language

+                               identifier.  This is the language of the controller 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.

+  @param[out]  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.

+

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

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

+RedfishConfigHandlerComponentNameGetControllerName (

+  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,

+  IN  EFI_HANDLE                   ControllerHandle,

+  IN  EFI_HANDLE                   ChildHandle        OPTIONAL,

+  IN  CHAR8                        *Language,

+  OUT CHAR16                       **ControllerName

+  );

+

+///

+/// Component Name Protocol instance

+///

+GLOBAL_REMOVE_IF_UNREFERENCED

+EFI_COMPONENT_NAME_PROTOCOL  gRedfishConfigHandlerComponentName = {

+  RedfishConfigHandlerComponentNameGetDriverName,

+  RedfishConfigHandlerComponentNameGetControllerName,

+  "eng"

+};

+

+///

+/// Component Name 2 Protocol instance

+///

+GLOBAL_REMOVE_IF_UNREFERENCED

+EFI_COMPONENT_NAME2_PROTOCOL  gRedfishConfigHandlerComponentName2 = {

+  (EFI_COMPONENT_NAME2_GET_DRIVER_NAME)RedfishConfigHandlerComponentNameGetDriverName,

+  (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME)RedfishConfigHandlerComponentNameGetControllerName,

+  "en"

+};

+

+///

+/// Table of driver names

+///

+GLOBAL_REMOVE_IF_UNREFERENCED

+EFI_UNICODE_STRING_TABLE  mRedfishConfigHandlerDriverNameTable[] = {

+  { "eng;en", (CHAR16 *)L"Redfish Configuration UEFI Driver" },

+  { NULL,     NULL                                           }

+};

+

+GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE  *gRedfishConfigHandlerControllerNameTable = NULL;

+

+/**

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

+

+  @param[in]  This        A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.

+  @param[in]  Language    A pointer to a three-character ISO 639-2 language identifier.

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

+  @param[out]  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.

+

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

+RedfishConfigHandlerComponentNameGetDriverName (

+  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,

+  IN  CHAR8                        *Language,

+  OUT CHAR16                       **DriverName

+  )

+{

+  return LookupUnicodeString2 (

+           Language,

+           This->SupportedLanguages,

+           mRedfishConfigHandlerDriverNameTable,

+           DriverName,

+           (BOOLEAN)(This == &gRedfishConfigHandlerComponentName)

+           );

+}

+

+/**

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

+  that is being managed by an EFI Driver.

+

+  @param[in]  This             A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.

+  @param[in]  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.

+  @param[in]  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.

+  @param[in]  Language         A pointer to a three character ISO 639-2 language

+                               identifier.  This is the language of the controller 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.

+  @param[out]  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.

+

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

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

+RedfishConfigHandlerComponentNameGetControllerName (

+  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,

+  IN  EFI_HANDLE                   ControllerHandle,

+  IN  EFI_HANDLE                   ChildHandle        OPTIONAL,

+  IN  CHAR8                        *Language,

+  OUT CHAR16                       **ControllerName

+  )

+{

+  return EFI_UNSUPPORTED;

+}

diff --git a/RedfishPkg/RedfishConfigHandler/RedfishConfigHandlerDriver.c b/RedfishPkg/RedfishConfigHandler/RedfishConfigHandlerDriver.c
index 2d0170d886..5e03132695 100644
--- a/RedfishPkg/RedfishConfigHandler/RedfishConfigHandlerDriver.c
+++ b/RedfishPkg/RedfishConfigHandler/RedfishConfigHandlerDriver.c
@@ -601,11 +601,17 @@ RedfishConfigHandlerDriverEntryPoint (
   //

   // Install UEFI Driver Model protocol(s).

   //

-  Status = EfiLibInstallDriverBinding (

+  Status = EfiLibInstallAllDriverProtocols2 (

              ImageHandle,

              SystemTable,

              &gRedfishConfigDriverBinding,

-             ImageHandle

+             ImageHandle,

+             &gRedfishConfigHandlerComponentName,

+             &gRedfishConfigHandlerComponentName2,

+             NULL,

+             NULL,

+             NULL,

+             NULL

              );

   if (EFI_ERROR (Status)) {

     gBS->CloseEvent (gEndOfDxeEvent);

diff --git a/RedfishPkg/RedfishConfigHandler/RedfishConfigHandlerDriver.h b/RedfishPkg/RedfishConfigHandler/RedfishConfigHandlerDriver.h
index 07214875bd..51701c05c6 100644
--- a/RedfishPkg/RedfishConfigHandler/RedfishConfigHandlerDriver.h
+++ b/RedfishPkg/RedfishConfigHandler/RedfishConfigHandlerDriver.h
@@ -24,7 +24,9 @@
 //

 // Protocol instances

 //

-extern EFI_DRIVER_BINDING_PROTOCOL  gRedfishConfigDriverBinding;

+extern EFI_DRIVER_BINDING_PROTOCOL   gRedfishConfigDriverBinding;

+extern EFI_COMPONENT_NAME_PROTOCOL   gRedfishConfigHandlerComponentName;

+extern EFI_COMPONENT_NAME2_PROTOCOL  gRedfishConfigHandlerComponentName2;

 

 extern REDFISH_CONFIG_DRIVER_DATA         gRedfishConfigData;

 extern EDKII_REDFISH_CREDENTIAL_PROTOCOL  *gCredential;

diff --git a/RedfishPkg/RedfishConfigHandler/RedfishConfigHandlerDriver.inf b/RedfishPkg/RedfishConfigHandler/RedfishConfigHandlerDriver.inf
index aed93f570c..40ce056137 100644
--- a/RedfishPkg/RedfishConfigHandler/RedfishConfigHandlerDriver.inf
+++ b/RedfishPkg/RedfishConfigHandler/RedfishConfigHandlerDriver.inf
@@ -30,6 +30,7 @@
   RedfishPkg/RedfishPkg.dec

 

 [Sources]

+  ComponentName.c

   RedfishConfigHandlerDriver.h

   RedfishConfigHandlerDriver.c

   RedfishConfigHandlerCommon.h