Initial import.

[mirror_edk2.git] / EdkModulePkg / Universal / Debugger / Debugport / Dxe / ComponentName.c

/*++\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
  ComponentName.c\r
\r
Abstract:\r
  Component name protocol member functions for DebugPort...\r
  \r
--*/\r
\r
#include "DebugPort.h"\r
\r
//\r
// EFI Component Name Protocol\r
//\r
EFI_COMPONENT_NAME_PROTOCOL     gDebugPortComponentName = {\r
  DebugPortComponentNameGetDriverName,\r
  DebugPortComponentNameGetControllerName,\r
  "eng"\r
};\r
\r
static EFI_UNICODE_STRING_TABLE mDebugPortDriverNameTable[] = {\r
  {\r
    "eng",\r
    (CHAR16 *) L"DebugPort Driver"\r
  },\r
  {\r
    NULL,\r
    NULL\r
  }\r
};\r
\r
EFI_STATUS\r
EFIAPI\r
DebugPortComponentNameGetDriverName (\r
  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,\r
  IN  CHAR8                        *Language,\r
  OUT CHAR16                       **DriverName\r
  )\r
/*++\r
\r
  Routine Description:\r
    Retrieves a Unicode string that is the user readable name of the EFI Driver.\r
\r
  Arguments:\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 specified\r
                 in SupportedLanguages.  The number of languages supported by a \r
                 driver is up to the driver writer.\r
    DriverName - A pointer to the Unicode string to return.  This Unicode string\r
                 is the name of the driver specified by This in the language \r
                 specified by Language.\r
\r
  Returns:\r
    EFI_SUCCESS           - The Unicode string for the Driver specified by This\r
                            and the language specified by Language was returned \r
                            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
\r
--*/\r
{\r
  return LookupUnicodeString (\r
           Language,\r
           gDebugPortComponentName.SupportedLanguages,\r
           mDebugPortDriverNameTable,\r
           DriverName\r
           );\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
DebugPortComponentNameGetControllerName (\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
  Routine Description:\r
    The debug port driver does not support GetControllerName, so this function\r
    is just stubbed and returns EFI_UNSUPPORTED.\r
\r
  Arguments:\r
    Per EFI 1.10 driver model\r
\r
  Returns:\r
    EFI_UNSUPPORTED\r
\r
--*/\r
{\r
  return EFI_UNSUPPORTED;\r
}\r