MdeModulePkg/Bus/Ata/AtaAtapiPassThru/ComponentName.c

   1 /** @file
   2   UEFI Component Name(2) protocol implementation for AtaAtapiPassThru driver.
   3
   4   Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.<BR>
   5   SPDX-License-Identifier: BSD-2-Clause-Patent
   6
   7 **/
   8
   9 #include "AtaAtapiPassThru.h"
  10
  11 //
  12 // Driver name table
  13 //
  14 GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE  mAtaAtapiPassThruDriverNameTable[] = {
  15   { "eng;en", L"AtaAtapiPassThru Driver" },
  16   { NULL,     NULL                       }
  17 };
  18
  19 //
  20 // Controller name table
  21 //
  22 GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE  mAtaAtapiPassThruIdeControllerNameTable[] = {
  23   { "eng;en", L"IDE Controller" },
  24   { NULL,     NULL              }
  25 };
  26
  27 GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE  mAtaAtapiPassThruAhciControllerNameTable[] = {
  28   { "eng;en", L"AHCI Controller" },
  29   { NULL,     NULL               }
  30 };
  31
  32 //
  33 // EFI Component Name Protocol
  34 //
  35 GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL  gAtaAtapiPassThruComponentName = {
  36   AtaAtapiPassThruComponentNameGetDriverName,
  37   AtaAtapiPassThruComponentNameGetControllerName,
  38   "eng"
  39 };
  40
  41 //
  42 // EFI Component Name 2 Protocol
  43 //
  44 GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL  gAtaAtapiPassThruComponentName2 = {
  45   (EFI_COMPONENT_NAME2_GET_DRIVER_NAME)AtaAtapiPassThruComponentNameGetDriverName,
  46   (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME)AtaAtapiPassThruComponentNameGetControllerName,
  47   "en"
  48 };
  49
  50 /**
  51   Retrieves a Unicode string that is the user readable name of the driver.
  52
  53   This function retrieves the user readable name of a driver in the form of a
  54   Unicode string. If the driver specified by This has a user readable name in
  55   the language specified by Language, then a pointer to the driver name is
  56   returned in DriverName, and EFI_SUCCESS is returned. If the driver specified
  57   by This does not support the language specified by Language,
  58   then EFI_UNSUPPORTED is returned.
  59
  60   @param  This[in]              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
  61                                 EFI_COMPONENT_NAME_PROTOCOL instance.
  62
  63   @param  Language[in]          A pointer to a Null-terminated ASCII string
  64                                 array indicating the language. This is the
  65                                 language of the driver name that the caller is
  66                                 requesting, and it must match one of the
  67                                 languages specified in SupportedLanguages. The
  68                                 number of languages supported by a driver is up
  69                                 to the driver writer. Language is specified
  70                                 in RFC 4646 or ISO 639-2 language code format.
  71
  72   @param  DriverName[out]       A pointer to the Unicode string to return.
  73                                 This Unicode string is the name of the
  74                                 driver specified by This in the language
  75                                 specified by Language.
  76
  77   @retval EFI_SUCCESS           The Unicode string for the Driver specified by
  78                                 This and the language specified by Language was
  79                                 returned in DriverName.
  80
  81   @retval EFI_INVALID_PARAMETER Language is NULL.
  82
  83   @retval EFI_INVALID_PARAMETER DriverName is NULL.
  84
  85   @retval EFI_UNSUPPORTED       The driver specified by This does not support
  86                                 the language specified by Language.
  87
  88 **/
  89 EFI_STATUS
  90 EFIAPI
  91 AtaAtapiPassThruComponentNameGetDriverName (
  92   IN  EFI_COMPONENT_NAME_PROTOCOL  *This,
  93   IN  CHAR8                        *Language,
  94   OUT CHAR16                       **DriverName
  95   )
  96 {
  97   return LookupUnicodeString2 (
  98            Language,
  99            This->SupportedLanguages,
 100            mAtaAtapiPassThruDriverNameTable,
 101            DriverName,
 102            (BOOLEAN)(This == &gAtaAtapiPassThruComponentName)
 103            );
 104 }
 105
 106 /**
 107   Retrieves a Unicode string that is the user readable name of the controller
 108   that is being managed by a driver.
 109
 110   This function retrieves the user readable name of the controller specified by
 111   ControllerHandle and ChildHandle in the form of a Unicode string. If the
 112   driver specified by This has a user readable name in the language specified by
 113   Language, then a pointer to the controller name is returned in ControllerName,
 114   and EFI_SUCCESS is returned.  If the driver specified by This is not currently
 115   managing the controller specified by ControllerHandle and ChildHandle,
 116   then EFI_UNSUPPORTED is returned.  If the driver specified by This does not
 117   support the language specified by Language, then EFI_UNSUPPORTED is returned.
 118
 119   @param  This[in]              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
 120                                 EFI_COMPONENT_NAME_PROTOCOL instance.
 121
 122   @param  ControllerHandle[in]  The handle of a controller that the driver
 123                                 specified by This is managing.  This handle
 124                                 specifies the controller whose name is to be
 125                                 returned.
 126
 127   @param  ChildHandle[in]       The handle of the child controller to retrieve
 128                                 the name of.  This is an optional parameter that
 129                                 may be NULL.  It will be NULL for device
 130                                 drivers.  It will also be NULL for a bus drivers
 131                                 that wish to retrieve the name of the bus
 132                                 controller.  It will not be NULL for a bus
 133                                 driver that wishes to retrieve the name of a
 134                                 child controller.
 135
 136   @param  Language[in]          A pointer to a Null-terminated ASCII string
 137                                 array indicating the language.  This is the
 138                                 language of the driver name that the caller is
 139                                 requesting, and it must match one of the
 140                                 languages specified in SupportedLanguages. The
 141                                 number of languages supported by a driver is up
 142                                 to the driver writer. Language is specified in
 143                                 RFC 4646 or ISO 639-2 language code format.
 144
 145   @param  ControllerName[out]   A pointer to the Unicode string to return.
 146                                 This Unicode string is the name of the
 147                                 controller specified by ControllerHandle and
 148                                 ChildHandle in the language specified by
 149                                 Language from the point of view of the driver
 150                                 specified by This.
 151
 152   @retval EFI_SUCCESS           The Unicode string for the user readable name in
 153                                 the language specified by Language for the
 154                                 driver specified by This was returned in
 155                                 DriverName.
 156
 157   @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.
 158
 159   @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid
 160                                 EFI_HANDLE.
 161
 162   @retval EFI_INVALID_PARAMETER Language is NULL.
 163
 164   @retval EFI_INVALID_PARAMETER ControllerName is NULL.
 165
 166   @retval EFI_UNSUPPORTED       The driver specified by This is not currently
 167                                 managing the controller specified by
 168                                 ControllerHandle and ChildHandle.
 169
 170   @retval EFI_UNSUPPORTED       The driver specified by This does not support
 171                                 the language specified by Language.
 172
 173 **/
 174 EFI_STATUS
 175 EFIAPI
 176 AtaAtapiPassThruComponentNameGetControllerName (
 177   IN  EFI_COMPONENT_NAME_PROTOCOL  *This,
 178   IN  EFI_HANDLE                   ControllerHandle,
 179   IN  EFI_HANDLE                   ChildHandle        OPTIONAL,
 180   IN  CHAR8                        *Language,
 181   OUT CHAR16                       **ControllerName
 182   )
 183 {
 184   EFI_STATUS                    Status;
 185   EFI_UNICODE_STRING_TABLE      *ControllerNameTable;
 186   VOID                          *Interface;
 187   ATA_ATAPI_PASS_THRU_INSTANCE  *Instance;
 188
 189   if ((Language == NULL) || (ControllerName == NULL)) {
 190     return EFI_INVALID_PARAMETER;
 191   }
 192
 193   //
 194   // This is a device driver, so ChildHandle must be NULL.
 195   //
 196   if (ChildHandle != NULL) {
 197     return EFI_UNSUPPORTED;
 198   }
 199
 200   //
 201   // Make sure this driver is currently managing Controller Handle
 202   //
 203   Status = EfiTestManagedDevice (
 204              ControllerHandle,
 205              gAtaAtapiPassThruDriverBinding.DriverBindingHandle,
 206              &gEfiIdeControllerInitProtocolGuid
 207              );
 208   if (EFI_ERROR (Status)) {
 209     return Status;
 210   }
 211
 212   //
 213   // AtaPassThru and ExtScsiPassThru should also be installed at the controller handle.
 214   //
 215   Status = gBS->OpenProtocol (
 216                   ControllerHandle,
 217                   &gEfiAtaPassThruProtocolGuid,
 218                   &Interface,
 219                   gAtaAtapiPassThruDriverBinding.DriverBindingHandle,
 220                   ControllerHandle,
 221                   EFI_OPEN_PROTOCOL_GET_PROTOCOL
 222                   );
 223   if (EFI_ERROR (Status)) {
 224     return EFI_UNSUPPORTED;
 225   }
 226
 227   Instance = ATA_PASS_THRU_PRIVATE_DATA_FROM_THIS (Interface);
 228
 229   if (Instance->Mode == EfiAtaIdeMode) {
 230     ControllerNameTable = mAtaAtapiPassThruIdeControllerNameTable;
 231   } else if (Instance->Mode == EfiAtaAhciMode) {
 232     ControllerNameTable = mAtaAtapiPassThruAhciControllerNameTable;
 233   } else {
 234     return EFI_UNSUPPORTED;
 235   }
 236
 237   return LookupUnicodeString2 (
 238            Language,
 239            This->SupportedLanguages,
 240            ControllerNameTable,
 241            ControllerName,
 242            (BOOLEAN)(This == &gAtaAtapiPassThruComponentName)
 243            );
 244 }