/** @file

;******************************************************************************
;* Copyright (c) 2012 - 2016, Insyde Software Corp. All Rights Reserved.
;*
;* You may not reproduce, distribute, publish, display, perform, modify, adapt,
;* transmit, broadcast, present, recite, release, license or otherwise exploit
;* any part of this publication in any form, by any means, without the prior
;* written permission of Insyde Software Corporation.
;*
;******************************************************************************
*/

#include <PciUartDxe.h>

//
// EFI Component Name Protocol
//
GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL gPciUartComponentName = {
  Pci16550ComponentNameGetDriverName,
  Pci16550ComponentNameGetControllerName,
  "eng"
};

GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL gPciUartComponentName2 = {
  (EFI_COMPONENT_NAME2_GET_DRIVER_NAME) Pci16550ComponentNameGetDriverName,
  (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) Pci16550ComponentNameGetControllerName,
  "en"
};

static EFI_UNICODE_STRING_TABLE mPciUartDriverNameTable[] = {
  {
    "eng;en",
    L"PCI Uart Driver"
  },
  {
    NULL,
    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 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[in] 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
Pci16550ComponentNameGetDriverName (
  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,
  IN  CHAR8                        *Language,
  OUT CHAR16                       **DriverName
  )
{
  return LookupUnicodeString2 (
           Language,
           This->SupportedLanguages,
           mPciUartDriverNameTable,
           DriverName,
           (BOOLEAN)(This == &gPciUartComponentName)
           );
}

/**
  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 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[in]  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
Pci16550ComponentNameGetControllerName (
  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,
  IN  EFI_HANDLE                   ControllerHandle,
  IN  EFI_HANDLE                   ChildHandle        OPTIONAL,
  IN  CHAR8                        *Language,
  OUT CHAR16                       **ControllerName
  )
{
  return EFI_UNSUPPORTED;
}