OvmfPkg/Bhyve/BhyveRfbDxe/ComponentName.c

   1 /** @file
   2
   3 Copyright (c) 2020, Rebecca Cran <rebecca@bsdio.com>
   4 Copyright (c) 2006, Intel Corporation. All rights reserved.<BR>
   5 Portions copyright (c) 2010,Apple Inc. All rights reserved.<BR>
   6
   7 SPDX-License-Identifier: BSD-2-Clause-Patent
   8
   9 Module Name:
  10
  11   ComponentName.c
  12
  13 Abstract:
  14
  15 **/
  16
  17 #include "Gop.h"
  18
  19 //
  20 // EFI Component Name Functions
  21 //
  22 EFI_STATUS
  23 EFIAPI
  24 EmuGopComponentNameGetDriverName (
  25   IN  EFI_COMPONENT_NAME_PROTOCOL  *This,
  26   IN  CHAR8                        *Language,
  27   OUT CHAR16                       **DriverName
  28   );
  29
  30 EFI_STATUS
  31 EFIAPI
  32 EmuGopComponentNameGetControllerName (
  33   IN  EFI_COMPONENT_NAME_PROTOCOL  *This,
  34   IN  EFI_HANDLE                   ControllerHandle,
  35   IN  EFI_HANDLE                   ChildHandle        OPTIONAL,
  36   IN  CHAR8                        *Language,
  37   OUT CHAR16                       **ControllerName
  38   );
  39
  40 //
  41 // EFI Component Name Protocol
  42 //
  43 EFI_COMPONENT_NAME_PROTOCOL  gEmuGopComponentName = {
  44   EmuGopComponentNameGetDriverName,
  45   EmuGopComponentNameGetControllerName,
  46   "eng"
  47 };
  48
  49 //
  50 // EFI Component Name 2 Protocol
  51 //
  52 GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL  gEmuGopComponentName2 = {
  53   (EFI_COMPONENT_NAME2_GET_DRIVER_NAME)EmuGopComponentNameGetDriverName,
  54   (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME)EmuGopComponentNameGetControllerName,
  55   "en"
  56 };
  57
  58 EFI_UNICODE_STRING_TABLE  mEmuGopDriverNameTable[] = {
  59   { "eng", L"Emulator GOP Driver" },
  60   { NULL,  NULL                   }
  61 };
  62
  63 /**
  64   Retrieves a Unicode string that is the user readable name of the driver.
  65
  66   This function retrieves the user readable name of a driver in the form of a
  67   Unicode string. If the driver specified by This has a user readable name in
  68   the language specified by Language, then a pointer to the driver name is
  69   returned in DriverName, and EFI_SUCCESS is returned. If the driver specified
  70   by This does not support the language specified by Language,
  71   then EFI_UNSUPPORTED is returned.
  72
  73   @param  This[in]              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
  74                                 EFI_COMPONENT_NAME_PROTOCOL instance.
  75
  76   @param  Language[in]          A pointer to a Null-terminated ASCII string
  77                                 array indicating the language. This is the
  78                                 language of the driver name that the caller is
  79                                 requesting, and it must match one of the
  80                                 languages specified in SupportedLanguages. The
  81                                 number of languages supported by a driver is up
  82                                 to the driver writer. Language is specified
  83                                 in RFC 4646 or ISO 639-2 language code format.
  84
  85   @param  DriverName[out]       A pointer to the Unicode string to return.
  86                                 This Unicode string is the name of the
  87                                 driver specified by This in the language
  88                                 specified by Language.
  89
  90   @retval EFI_SUCCESS           The Unicode string for the Driver specified by
  91                                 This and the language specified by Language was
  92                                 returned in DriverName.
  93
  94   @retval EFI_INVALID_PARAMETER Language is NULL.
  95
  96   @retval EFI_INVALID_PARAMETER DriverName is NULL.
  97
  98   @retval EFI_UNSUPPORTED       The driver specified by This does not support
  99                                 the language specified by Language.
 100
 101 **/
 102 EFI_STATUS
 103 EFIAPI
 104 EmuGopComponentNameGetDriverName (
 105   IN  EFI_COMPONENT_NAME_PROTOCOL  *This,
 106   IN  CHAR8                        *Language,
 107   OUT CHAR16                       **DriverName
 108   )
 109 {
 110   return LookupUnicodeString2 (
 111            Language,
 112            This->SupportedLanguages,
 113            mEmuGopDriverNameTable,
 114            DriverName,
 115            (BOOLEAN)(This == &gEmuGopComponentName)
 116            );
 117 }
 118
 119 /**
 120   Retrieves a Unicode string that is the user readable name of the controller
 121   that is being managed by a driver.
 122
 123   This function retrieves the user readable name of the controller specified by
 124   ControllerHandle and ChildHandle in the form of a Unicode string. If the
 125   driver specified by This has a user readable name in the language specified by
 126   Language, then a pointer to the controller name is returned in ControllerName,
 127   and EFI_SUCCESS is returned.  If the driver specified by This is not currently
 128   managing the controller specified by ControllerHandle and ChildHandle,
 129   then EFI_UNSUPPORTED is returned.  If the driver specified by This does not
 130   support the language specified by Language, then EFI_UNSUPPORTED is returned.
 131
 132   @param  This[in]              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
 133                                 EFI_COMPONENT_NAME_PROTOCOL instance.
 134
 135   @param  ControllerHandle[in]  The handle of a controller that the driver
 136                                 specified by This is managing.  This handle
 137                                 specifies the controller whose name is to be
 138                                 returned.
 139
 140   @param  ChildHandle[in]       The handle of the child controller to retrieve
 141                                 the name of.  This is an optional parameter that
 142                                 may be NULL.  It will be NULL for device
 143                                 drivers.  It will also be NULL for a bus drivers
 144                                 that wish to retrieve the name of the bus
 145                                 controller.  It will not be NULL for a bus
 146                                 driver that wishes to retrieve the name of a
 147                                 child controller.
 148
 149   @param  Language[in]          A pointer to a Null-terminated ASCII string
 150                                 array indicating the language.  This is the
 151                                 language of the driver name that the caller is
 152                                 requesting, and it must match one of the
 153                                 languages specified in SupportedLanguages. The
 154                                 number of languages supported by a driver is up
 155                                 to the driver writer. Language is specified in
 156                                 RFC 4646 or ISO 639-2 language code format.
 157
 158   @param  ControllerName[out]   A pointer to the Unicode string to return.
 159                                 This Unicode string is the name of the
 160                                 controller specified by ControllerHandle and
 161                                 ChildHandle in the language specified by
 162                                 Language from the point of view of the driver
 163                                 specified by This.
 164
 165   @retval EFI_SUCCESS           The Unicode string for the user readable name in
 166                                 the language specified by Language for the
 167                                 driver specified by This was returned in
 168                                 DriverName.
 169
 170   @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.
 171
 172   @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid
 173                                 EFI_HANDLE.
 174
 175   @retval EFI_INVALID_PARAMETER Language is NULL.
 176
 177   @retval EFI_INVALID_PARAMETER ControllerName is NULL.
 178
 179   @retval EFI_UNSUPPORTED       The driver specified by This is not currently
 180                                 managing the controller specified by
 181                                 ControllerHandle and ChildHandle.
 182
 183   @retval EFI_UNSUPPORTED       The driver specified by This does not support
 184                                 the language specified by Language.
 185
 186 **/
 187 EFI_STATUS
 188 EFIAPI
 189 EmuGopComponentNameGetControllerName (
 190   IN  EFI_COMPONENT_NAME_PROTOCOL  *This,
 191   IN  EFI_HANDLE                   ControllerHandle,
 192   IN  EFI_HANDLE                   ChildHandle        OPTIONAL,
 193   IN  CHAR8                        *Language,
 194   OUT CHAR16                       **ControllerName
 195   )
 196 {
 197   return EFI_UNSUPPORTED;
 198 }