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

[mirror_edk2.git] / Nt32Pkg / WinNtGopDxe / ComponentName.c

/** @file\r
\r
Copyright (c) 2006, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution.  The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
Module Name:\r
\r
  ComponentName.c\r
\r
Abstract:\r
\r
\r
**/\r
\r
//\r
// The package level header files this module uses\r
//\r
#include <Uefi.h>\r
#include <WinNtDxe.h>\r
//\r
// The protocols, PPI and GUID defintions for this module\r
//\r
#include <Guid/EventGroup.h>\r
#include <Protocol/WinNtIo.h>\r
#include <Protocol/ComponentName.h>\r
#include <Protocol/SimpleTextIn.h>\r
#include <Protocol/DriverBinding.h>\r
#include <Protocol/GraphicsOutput.h>\r
//\r
// The Library classes this module consumes\r
//\r
#include <Library/DebugLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/UefiDriverEntryPoint.h>\r
#include <Library/UefiLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
\r
#include "WinNtGop.h"\r
\r
//\r
// EFI Component Name Functions\r
//\r
EFI_STATUS\r
EFIAPI\r
WinNtGopComponentNameGetDriverName (\r
  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,\r
  IN  CHAR8                        *Language,\r
  OUT CHAR16                       **DriverName\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
WinNtGopComponentNameGetControllerName (\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
// EFI Component Name Protocol\r
//\r
EFI_COMPONENT_NAME_PROTOCOL     gWinNtGopComponentName = {\r
  WinNtGopComponentNameGetDriverName,\r
  WinNtGopComponentNameGetControllerName,\r
  "eng"\r
};\r
\r
static EFI_UNICODE_STRING_TABLE mWinNtGopDriverNameTable[] = {\r
  { "eng", L"Windows GOP Driver" },\r
  { NULL , NULL }\r
};\r
\r
\r
/**\r
  Retrieves a Unicode string that is the user readable name of the EFI Driver.\r
\r
  @param  This                   A pointer to the EFI_COMPONENT_NAME_PROTOCOL\r
                                 instance.\r
  @param  Language               A pointer to a three character ISO 639-2 language\r
                                 identifier. This is the language of the driver\r
                                 name that that the caller  is requesting, and it\r
                                 must match one of the languages specified in\r
                                 SupportedLanguages.  The number of languages\r
                                 supported by a  driver is up to the driver writer.\r
  @param  DriverName             A pointer to the Unicode string to return.  This\r
                                 Unicode string is the name of the driver specified\r
                                 by This in the language  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
  @retval EFI_INVALID_PARAMETER  Language is NULL.\r
  @retval EFI_INVALID_PARAMETER  DriverName is NULL.\r
  @retval EFI_UNSUPPORTED        The driver specified by This does not support the\r
                                 language specified by Language.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
WinNtGopComponentNameGetDriverName (\r
  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,\r
  IN  CHAR8                        *Language,\r
  OUT CHAR16                       **DriverName\r
  )\r
{\r
  return LookupUnicodeString (\r
          Language,\r
          gWinNtGopComponentName.SupportedLanguages,\r
          mWinNtGopDriverNameTable,\r
          DriverName\r
          );\r
}\r
\r
\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
  @param  This                   A pointer to the EFI_COMPONENT_NAME_PROTOCOL\r
                                 instance.\r
  @param  ControllerHandle       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
  @param  ChildHandle            The handle of the child controller to retrieve the\r
                                 name  of.  This is an optional parameter that may\r
                                 be NULL.  It  will be NULL for device drivers.  It\r
                                 will also be NULL  for a bus drivers that wish to\r
                                 retrieve the name of the  bus controller.  It will\r
                                 not be NULL for a bus driver  that wishes to\r
                                 retrieve the name of a child controller.\r
  @param  Language               A pointer to a three character ISO 639-2 language\r
                                 identifier.  This is the language of the\r
                                 controller name  that that the caller is\r
                                 requesting, and it must match one of the languages\r
                                 specified in SupportedLanguages.  The  number of\r
                                 languages supported by a driver is up to the\r
                                 driver writer.\r
  @param  ControllerName         A pointer to the Unicode string to return.  This\r
                                 Unicode string is the name of the controller\r
                                 specified by  ControllerHandle and ChildHandle in\r
                                 the language specified by Language from the point\r
                                 of view of the driver 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 driver\r
                                  specified by This was returned in DriverName.\r
  @retval EFI_INVALID_PARAMETER  ControllerHandle is not a valid EFI_HANDLE.\r
  @retval EFI_INVALID_PARAMETER  ChildHandle is not NULL and it is not a valid\r
                                 EFI_HANDLE.\r
  @retval EFI_INVALID_PARAMETER  Language is NULL.\r
  @retval EFI_INVALID_PARAMETER  ControllerName is NULL.\r
  @retval EFI_UNSUPPORTED        The driver specified by This is not currently\r
                                 managing  the controller specified by\r
                                 ControllerHandle and  ChildHandle.\r
  @retval EFI_UNSUPPORTED        The driver specified by This does not support the\r
                                 language specified by Language.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
WinNtGopComponentNameGetControllerName (\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
  EFI_STATUS                   Status;\r
  EFI_GRAPHICS_OUTPUT_PROTOCOL *GraphicsOutput;\r
  GOP_PRIVATE_DATA             *Private;\r
\r
  //\r
  // This is a device driver, so ChildHandle must be NULL.\r
  //\r
  if (ChildHandle != NULL) {\r
    return EFI_UNSUPPORTED;\r
  }\r
  //\r
  // Make sure this driver is currently managing ControllerHandle\r
  //\r
  Status = EfiTestManagedDevice (\r
             ControllerHandle,\r
             gWinNtGopDriverBinding.DriverBindingHandle,\r
             &gEfiWinNtIoProtocolGuid\r
             );\r
  if (EFI_ERROR (Status)) {\r
    return EFI_UNSUPPORTED;\r
  }\r
  //\r
  // Get our context back\r
  //\r
  Status = gBS->OpenProtocol (\r
                  ControllerHandle,\r
                  &gEfiGraphicsOutputProtocolGuid,\r
                  &GraphicsOutput,\r
                  gWinNtGopDriverBinding.DriverBindingHandle,\r
                  ControllerHandle,\r
                  EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  Private = GOP_PRIVATE_DATA_FROM_THIS (GraphicsOutput);\r
\r
  return LookupUnicodeString (\r
          Language,\r
          gWinNtGopComponentName.SupportedLanguages,\r
          Private->ControllerNameTable,\r
          ControllerName\r
          );\r
}\r