MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ComponentName.c

   1 /** @file
   2   UEFI Component Name(2) protocol implementation for SCSI disk driver.
   3
   4 Copyright (c) 2004 - 2008, Intel Corporation. <BR>
   5 All rights reserved. This program and the accompanying materials
   6 are licensed and made available under the terms and conditions of the BSD License
   7 which accompanies this distribution.  The full text of the license may be found at
   8 http://opensource.org/licenses/bsd-license.php
   9
  10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15
  16 #include <PiDxe.h>
  17
  18
  19 #include <Protocol/ScsiIo.h>
  20 #include <Protocol/ComponentName.h>
  21 #include <Protocol/BlockIo.h>
  22 #include <Protocol/DriverBinding.h>
  23
  24 #include <Library/DebugLib.h>
  25 #include <Library/UefiDriverEntryPoint.h>
  26 #include <Library/UefiLib.h>
  27 #include <Library/BaseMemoryLib.h>
  28 #include <Library/ScsiLib.h>
  29 #include <Library/UefiBootServicesTableLib.h>
  30
  31 #include "ScsiDisk.h"
  32
  33 //
  34 // EFI Component Name Protocol
  35 //
  36 GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL  gScsiDiskComponentName = {
  37   ScsiDiskComponentNameGetDriverName,
  38   ScsiDiskComponentNameGetControllerName,
  39   "eng"
  40 };
  41
  42 //
  43 // EFI Component Name 2 Protocol
  44 //
  45 GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL gScsiDiskComponentName2 = {
  46   (EFI_COMPONENT_NAME2_GET_DRIVER_NAME) ScsiDiskComponentNameGetDriverName,
  47   (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) ScsiDiskComponentNameGetControllerName,
  48   "en"
  49 };
  50
  51
  52 GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mScsiDiskDriverNameTable[] = {
  53   { "eng;en", (CHAR16 *) L"Scsi Disk Driver" },
  54   { NULL , NULL }
  55 };
  56
  57 /**
  58   Retrieves a Unicode string that is the user readable name of the driver.
  59
  60   This function retrieves the user readable name of a driver in the form of a
  61   Unicode string. If the driver specified by This has a user readable name in
  62   the language specified by Language, then a pointer to the driver name is
  63   returned in DriverName, and EFI_SUCCESS is returned. If the driver specified
  64   by This does not support the language specified by Language,
  65   then EFI_UNSUPPORTED is returned.
  66
  67   @param  This[in]              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
  68                                 EFI_COMPONENT_NAME_PROTOCOL instance.
  69
  70   @param  Language[in]          A pointer to a Null-terminated ASCII string
  71                                 array indicating the language. This is the
  72                                 language of the driver name that the caller is
  73                                 requesting, and it must match one of the
  74                                 languages specified in SupportedLanguages. The
  75                                 number of languages supported by a driver is up
  76                                 to the driver writer. Language is specified
  77                                 in RFC 3066 or ISO 639-2 language code format.
  78
  79   @param  DriverName[out]       A pointer to the Unicode string to return.
  80                                 This Unicode string is the name of the
  81                                 driver specified by This in the language
  82                                 specified by Language.
  83
  84   @retval EFI_SUCCESS           The Unicode string for the Driver specified by
  85                                 This and the language specified by Language was
  86                                 returned in DriverName.
  87
  88   @retval EFI_INVALID_PARAMETER Language is NULL.
  89
  90   @retval EFI_INVALID_PARAMETER DriverName is NULL.
  91
  92   @retval EFI_UNSUPPORTED       The driver specified by This does not support
  93                                 the language specified by Language.
  94
  95 **/
  96 EFI_STATUS
  97 EFIAPI
  98 ScsiDiskComponentNameGetDriverName (
  99   IN  EFI_COMPONENT_NAME_PROTOCOL  *This,
 100   IN  CHAR8                        *Language,
 101   OUT CHAR16                       **DriverName
 102   )
 103 {
 104   return LookupUnicodeString2 (
 105            Language,
 106            This->SupportedLanguages,
 107            mScsiDiskDriverNameTable,
 108            DriverName,
 109            (BOOLEAN)(This == &gScsiDiskComponentName)
 110            );
 111 }
 112
 113 /**
 114   Retrieves a Unicode string that is the user readable name of the controller
 115   that is being managed by a driver.
 116
 117   This function retrieves the user readable name of the controller specified by
 118   ControllerHandle and ChildHandle in the form of a Unicode string. If the
 119   driver specified by This has a user readable name in the language specified by
 120   Language, then a pointer to the controller name is returned in ControllerName,
 121   and EFI_SUCCESS is returned.  If the driver specified by This is not currently
 122   managing the controller specified by ControllerHandle and ChildHandle,
 123   then EFI_UNSUPPORTED is returned.  If the driver specified by This does not
 124   support the language specified by Language, then EFI_UNSUPPORTED is returned.
 125
 126   @param  This[in]              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
 127                                 EFI_COMPONENT_NAME_PROTOCOL instance.
 128
 129   @param  ControllerHandle[in]  The handle of a controller that the driver
 130                                 specified by This is managing.  This handle
 131                                 specifies the controller whose name is to be
 132                                 returned.
 133
 134   @param  ChildHandle[in]       The handle of the child controller to retrieve
 135                                 the name of.  This is an optional parameter that
 136                                 may be NULL.  It will be NULL for device
 137                                 drivers.  It will also be NULL for a bus drivers
 138                                 that wish to retrieve the name of the bus
 139                                 controller.  It will not be NULL for a bus
 140                                 driver that wishes to retrieve the name of a
 141                                 child controller.
 142
 143   @param  Language[in]          A pointer to a Null-terminated ASCII string
 144                                 array indicating the language.  This is the
 145                                 language of the driver name that the caller is
 146                                 requesting, and it must match one of the
 147                                 languages specified in SupportedLanguages. The
 148                                 number of languages supported by a driver is up
 149                                 to the driver writer. Language is specified in
 150                                 RFC 3066 or ISO 639-2 language code format.
 151
 152   @param  ControllerName[out]   A pointer to the Unicode string to return.
 153                                 This Unicode string is the name of the
 154                                 controller specified by ControllerHandle and
 155                                 ChildHandle in the language specified by
 156                                 Language from the point of view of the driver
 157                                 specified by This.
 158
 159   @retval EFI_SUCCESS           The Unicode string for the user readable name in
 160                                 the language specified by Language for the
 161                                 driver specified by This was returned in
 162                                 DriverName.
 163
 164   @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.
 165
 166   @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid
 167                                 EFI_HANDLE.
 168
 169   @retval EFI_INVALID_PARAMETER Language is NULL.
 170
 171   @retval EFI_INVALID_PARAMETER ControllerName is NULL.
 172
 173   @retval EFI_UNSUPPORTED       The driver specified by This is not currently
 174                                 managing the controller specified by
 175                                 ControllerHandle and ChildHandle.
 176
 177   @retval EFI_UNSUPPORTED       The driver specified by This does not support
 178                                 the language specified by Language.
 179
 180 **/
 181 EFI_STATUS
 182 EFIAPI
 183 ScsiDiskComponentNameGetControllerName (
 184   IN  EFI_COMPONENT_NAME_PROTOCOL                     *This,
 185   IN  EFI_HANDLE                                      ControllerHandle,
 186   IN  EFI_HANDLE                                      ChildHandle        OPTIONAL,
 187   IN  CHAR8                                           *Language,
 188   OUT CHAR16                                          **ControllerName
 189   )
 190 {
 191   EFI_STATUS            Status;
 192   SCSI_DISK_DEV         *ScsiDiskDevice;
 193   EFI_BLOCK_IO_PROTOCOL *BlockIo;
 194
 195   //
 196   // This is a device driver, so ChildHandle must be NULL.
 197   //
 198   if (ChildHandle != NULL) {
 199     return EFI_UNSUPPORTED;
 200   }
 201
 202   //
 203   // Make sure this driver is currently managing ControllerHandle
 204   //
 205   Status = EfiTestManagedDevice (
 206              ControllerHandle,
 207              gScsiDiskDriverBinding.DriverBindingHandle,
 208              &gEfiScsiIoProtocolGuid
 209              );
 210   if (EFI_ERROR (Status)) {
 211     return Status;
 212   }
 213   //
 214   // Get the device context
 215   //
 216   Status = gBS->OpenProtocol (
 217                   ControllerHandle,
 218                   &gEfiBlockIoProtocolGuid,
 219                   (VOID **) &BlockIo,
 220                   gScsiDiskDriverBinding.DriverBindingHandle,
 221                   ControllerHandle,
 222                   EFI_OPEN_PROTOCOL_GET_PROTOCOL
 223                   );
 224
 225   if (EFI_ERROR (Status)) {
 226     return Status;
 227   }
 228
 229   ScsiDiskDevice = SCSI_DISK_DEV_FROM_THIS (BlockIo);
 230
 231   return LookupUnicodeString2 (
 232            Language,
 233            This->SupportedLanguages,
 234            ScsiDiskDevice->ControllerNameTable,
 235            ControllerName,
 236            (BOOLEAN)(This == &gScsiDiskComponentName)
 237            );
 238
 239 }