MdeModulePkg/Universal/Disk/DiskIoDxe/ComponentName.c

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