EdkNt32Pkg/Dxe/WinNtThunk/Bus/Gop/ComponentName.c

/** @file

Copyright (c) 2006, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution.  The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

Module Name:

  ComponentName.c

Abstract:


**/

#include "WinNtGop.h"

//
// EFI Component Name Functions
//
EFI_STATUS
EFIAPI
WinNtGopComponentNameGetDriverName (
  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,
  IN  CHAR8                        *Language,
  OUT CHAR16                       **DriverName
  );

EFI_STATUS
EFIAPI
WinNtGopComponentNameGetControllerName (
  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     gWinNtGopComponentName = {
  WinNtGopComponentNameGetDriverName,
  WinNtGopComponentNameGetControllerName,
  "eng"
};

static EFI_UNICODE_STRING_TABLE mWinNtGopDriverNameTable[] = {
  { "eng", L"Windows GOP Driver" },
  { NULL , NULL }
};


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

  @param  This                   A pointer to the EFI_COMPONENT_NAME_PROTOCOL
                                 instance.
  @param  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.
  @param  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
WinNtGopComponentNameGetDriverName (
  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,
  IN  CHAR8                        *Language,
  OUT CHAR16                       **DriverName
  )
{
  return LookupUnicodeString (
          Language,
          gWinNtGopComponentName.SupportedLanguages,
          mWinNtGopDriverNameTable,
          DriverName
          );
}


/**
  Retrieves a Unicode string that is the user readable name of the controller
  that is being managed by an EFI Driver.

  @param  This                   A pointer to the EFI_COMPONENT_NAME_PROTOCOL
                                 instance.
  @param  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  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  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.
  @param  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 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
WinNtGopComponentNameGetControllerName (
  IN  EFI_COMPONENT_NAME_PROTOCOL                     *This,
  IN  EFI_HANDLE                                      ControllerHandle,
  IN  EFI_HANDLE                                      ChildHandle        OPTIONAL,
  IN  CHAR8                                           *Language,
  OUT CHAR16                                          **ControllerName
  )
{
  EFI_STATUS                   Status;
  EFI_GRAPHICS_OUTPUT_PROTOCOL *GraphicsOutput;
  GOP_PRIVATE_DATA             *Private;

  //
  // This is a device driver, so ChildHandle must be NULL.
  //
  if (ChildHandle != NULL) {
    return EFI_UNSUPPORTED;
  }
  //
  // Make sure this driver is currently managing ControllerHandle
  //
  Status = EfiTestManagedDevice (
             ControllerHandle,
             gWinNtGopDriverBinding.DriverBindingHandle,
             &gEfiWinNtIoProtocolGuid
             );
  if (EFI_ERROR (Status)) {
    return EFI_UNSUPPORTED;
  }
  //
  // Get our context back
  //
  Status = gBS->OpenProtocol (
                  ControllerHandle,
                  &gEfiGraphicsOutputProtocolGuid,
                  &GraphicsOutput,
                  gWinNtGopDriverBinding.DriverBindingHandle,
                  ControllerHandle,
                  EFI_OPEN_PROTOCOL_GET_PROTOCOL
                  );
  if (EFI_ERROR (Status)) {
    return EFI_UNSUPPORTED;
  }

  Private = GOP_PRIVATE_DATA_FROM_THIS (GraphicsOutput);

  return LookupUnicodeString (
          Language,
          gWinNtGopComponentName.SupportedLanguages,
          Private->ControllerNameTable,
          ControllerName
          );
}