MdeModulePkg/Universal/DebugPortDxe/ComponentName.c

   1 /*++
   2
   3 Copyright (c) 2006, Intel Corporation
   4 All rights reserved. This program and the accompanying materials
   5 are licensed and made available under the terms and conditions of the BSD License
   6 which accompanies this distribution.  The full text of the license may be found at
   7 http://opensource.org/licenses/bsd-license.php
   8
   9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  11
  12 Module Name:
  13   ComponentName.c
  14
  15 Abstract:
  16   Component name protocol member functions for DebugPort...
  17
  18 --*/
  19
  20 #include "DebugPort.h"
  21
  22 //
  23 // EFI Component Name Protocol
  24 //
  25 EFI_COMPONENT_NAME_PROTOCOL     gDebugPortComponentName = {
  26   DebugPortComponentNameGetDriverName,
  27   DebugPortComponentNameGetControllerName,
  28   "eng"
  29 };
  30
  31 static EFI_UNICODE_STRING_TABLE mDebugPortDriverNameTable[] = {
  32   {
  33     "eng",
  34     (CHAR16 *) L"DebugPort Driver"
  35   },
  36   {
  37     NULL,
  38     NULL
  39   }
  40 };
  41
  42 EFI_STATUS
  43 EFIAPI
  44 DebugPortComponentNameGetDriverName (
  45   IN  EFI_COMPONENT_NAME_PROTOCOL  *This,
  46   IN  CHAR8                        *Language,
  47   OUT CHAR16                       **DriverName
  48   )
  49 /*++
  50
  51   Routine Description:
  52     Retrieves a Unicode string that is the user readable name of the EFI Driver.
  53
  54   Arguments:
  55     This       - A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
  56     Language   - A pointer to a three character ISO 639-2 language identifier.
  57                  This is the language of the driver name that that the caller
  58                  is requesting, and it must match one of the languages specified
  59                  in SupportedLanguages.  The number of languages supported by a
  60                  driver is up to the driver writer.
  61     DriverName - A pointer to the Unicode string to return.  This Unicode string
  62                  is the name of the driver specified by This in the language
  63                  specified by Language.
  64
  65   Returns:
  66     EFI_SUCCESS           - The Unicode string for the Driver specified by This
  67                             and the language specified by Language was returned
  68                             in DriverName.
  69     EFI_INVALID_PARAMETER - Language is NULL.
  70     EFI_INVALID_PARAMETER - DriverName is NULL.
  71     EFI_UNSUPPORTED       - The driver specified by This does not support the
  72                             language specified by Language.
  73
  74 --*/
  75 {
  76   return LookupUnicodeString (
  77            Language,
  78            gDebugPortComponentName.SupportedLanguages,
  79            mDebugPortDriverNameTable,
  80            DriverName
  81            );
  82 }
  83
  84 EFI_STATUS
  85 EFIAPI
  86 DebugPortComponentNameGetControllerName (
  87   IN  EFI_COMPONENT_NAME_PROTOCOL                     *This,
  88   IN  EFI_HANDLE                                      ControllerHandle,
  89   IN  EFI_HANDLE                                      ChildHandle        OPTIONAL,
  90   IN  CHAR8                                           *Language,
  91   OUT CHAR16                                          **ControllerName
  92   )
  93 /*++
  94
  95   Routine Description:
  96     The debug port driver does not support GetControllerName, so this function
  97     is just stubbed and returns EFI_UNSUPPORTED.
  98
  99   Arguments:
 100     Per EFI 1.10 driver model
 101
 102   Returns:
 103     EFI_UNSUPPORTED
 104
 105 --*/
 106 {
 107   return EFI_UNSUPPORTED;
 108 }