MdeModulePkg/Universal/Network/SnpDxe/ComponentName.c

   1 /** @file
   2     UEFI Component Name(2) protocol implementation for SnpDxe driver.
   3
   4 Copyright (c) 2004 - 2008, Intel Corporation. All rights reserved.<BR>
   5 This program and the accompanying materials are licensed
   6 and made available under the terms and conditions of the BSD License which
   7 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 "Snp.h"
  17
  18 //
  19 // EFI Component Name Functions
  20 //
  21 /**
  22   Retrieves a Unicode string that is the user readable name of the driver.
  23
  24   This function retrieves the user readable name of a driver in the form of a
  25   Unicode string. If the driver specified by This has a user readable name in
  26   the language specified by Language, then a pointer to the driver name is
  27   returned in DriverName, and EFI_SUCCESS is returned. If the driver specified
  28   by This does not support the language specified by Language,
  29   then EFI_UNSUPPORTED is returned.
  30
  31   @param  This[in]              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
  32                                 EFI_COMPONENT_NAME_PROTOCOL instance.
  33
  34   @param  Language[in]          A pointer to a Null-terminated ASCII string
  35                                 array indicating the language. This is the
  36                                 language of the driver name that the caller is
  37                                 requesting, and it must match one of the
  38                                 languages specified in SupportedLanguages. The
  39                                 number of languages supported by a driver is up
  40                                 to the driver writer. Language is specified
  41                                 in RFC 4646 or ISO 639-2 language code format.
  42
  43   @param  DriverName[out]       A pointer to the Unicode string to return.
  44                                 This Unicode string is the name of the
  45                                 driver specified by This in the language
  46                                 specified by Language.
  47
  48   @retval EFI_SUCCESS           The Unicode string for the Driver specified by
  49                                 This and the language specified by Language was
  50                                 returned in DriverName.
  51
  52   @retval EFI_INVALID_PARAMETER Language is NULL.
  53
  54   @retval EFI_INVALID_PARAMETER DriverName is NULL.
  55
  56   @retval EFI_UNSUPPORTED       The driver specified by This does not support
  57                                 the language specified by Language.
  58
  59 **/
  60 EFI_STATUS
  61 EFIAPI
  62 SimpleNetworkComponentNameGetDriverName (
  63   IN  EFI_COMPONENT_NAME_PROTOCOL  *This,
  64   IN  CHAR8                        *Language,
  65   OUT CHAR16                       **DriverName
  66   );
  67
  68
  69 /**
  70   Retrieves a Unicode string that is the user readable name of the controller
  71   that is being managed by a driver.
  72
  73   This function retrieves the user readable name of the controller specified by
  74   ControllerHandle and ChildHandle in the form of a Unicode string. If the
  75   driver specified by This has a user readable name in the language specified by
  76   Language, then a pointer to the controller name is returned in ControllerName,
  77   and EFI_SUCCESS is returned.  If the driver specified by This is not currently
  78   managing the controller specified by ControllerHandle and ChildHandle,
  79   then EFI_UNSUPPORTED is returned.  If the driver specified by This does not
  80   support the language specified by Language, then EFI_UNSUPPORTED is returned.
  81
  82   @param  This[in]              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
  83                                 EFI_COMPONENT_NAME_PROTOCOL instance.
  84
  85   @param  ControllerHandle[in]  The handle of a controller that the driver
  86                                 specified by This is managing.  This handle
  87                                 specifies the controller whose name is to be
  88                                 returned.
  89
  90   @param  ChildHandle[in]       The handle of the child controller to retrieve
  91                                 the name of.  This is an optional parameter that
  92                                 may be NULL.  It will be NULL for device
  93                                 drivers.  It will also be NULL for a bus drivers
  94                                 that wish to retrieve the name of the bus
  95                                 controller.  It will not be NULL for a bus
  96                                 driver that wishes to retrieve the name of a
  97                                 child controller.
  98
  99   @param  Language[in]          A pointer to a Null-terminated ASCII string
 100                                 array indicating the language.  This is the
 101                                 language of the driver name that the caller is
 102                                 requesting, and it must match one of the
 103                                 languages specified in SupportedLanguages. The
 104                                 number of languages supported by a driver is up
 105                                 to the driver writer. Language is specified in
 106                                 RFC 4646 or ISO 639-2 language code format.
 107
 108   @param  ControllerName[out]   A pointer to the Unicode string to return.
 109                                 This Unicode string is the name of the
 110                                 controller specified by ControllerHandle and
 111                                 ChildHandle in the language specified by
 112                                 Language from the point of view of the driver
 113                                 specified by This.
 114
 115   @retval EFI_SUCCESS           The Unicode string for the user readable name in
 116                                 the language specified by Language for the
 117                                 driver specified by This was returned in
 118                                 DriverName.
 119
 120   @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.
 121
 122   @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid
 123                                 EFI_HANDLE.
 124
 125   @retval EFI_INVALID_PARAMETER Language is NULL.
 126
 127   @retval EFI_INVALID_PARAMETER ControllerName is NULL.
 128
 129   @retval EFI_UNSUPPORTED       The driver specified by This is not currently
 130                                 managing the controller specified by
 131                                 ControllerHandle and ChildHandle.
 132
 133   @retval EFI_UNSUPPORTED       The driver specified by This does not support
 134                                 the language specified by Language.
 135
 136 **/
 137 EFI_STATUS
 138 EFIAPI
 139 SimpleNetworkComponentNameGetControllerName (
 140   IN  EFI_COMPONENT_NAME_PROTOCOL                     *This,
 141   IN  EFI_HANDLE                                      ControllerHandle,
 142   IN  EFI_HANDLE                                      ChildHandle        OPTIONAL,
 143   IN  CHAR8                                           *Language,
 144   OUT CHAR16                                          **ControllerName
 145   );
 146
 147
 148 //
 149 // EFI Component Name Protocol
 150 //
 151 GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL  gSimpleNetworkComponentName = {
 152   SimpleNetworkComponentNameGetDriverName,
 153   SimpleNetworkComponentNameGetControllerName,
 154   "eng"
 155 };
 156
 157 //
 158 // EFI Component Name 2 Protocol
 159 //
 160 GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL gSimpleNetworkComponentName2 = {
 161   (EFI_COMPONENT_NAME2_GET_DRIVER_NAME) SimpleNetworkComponentNameGetDriverName,
 162   (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) SimpleNetworkComponentNameGetControllerName,
 163   "en"
 164 };
 165
 166
 167 GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mSimpleNetworkDriverNameTable[] = {
 168   {
 169     "eng;en",
 170     L"Simple Network Protocol Driver"
 171   },
 172   {
 173     NULL,
 174     NULL
 175   }
 176 };
 177
 178 /**
 179   Retrieves a Unicode string that is the user readable name of the driver.
 180
 181   This function retrieves the user readable name of a driver in the form of a
 182   Unicode string. If the driver specified by This has a user readable name in
 183   the language specified by Language, then a pointer to the driver name is
 184   returned in DriverName, and EFI_SUCCESS is returned. If the driver specified
 185   by This does not support the language specified by Language,
 186   then EFI_UNSUPPORTED is returned.
 187
 188   @param  This[in]              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
 189                                 EFI_COMPONENT_NAME_PROTOCOL instance.
 190
 191   @param  Language[in]          A pointer to a Null-terminated ASCII string
 192                                 array indicating the language. This is the
 193                                 language of the driver name that the caller is
 194                                 requesting, and it must match one of the
 195                                 languages specified in SupportedLanguages. The
 196                                 number of languages supported by a driver is up
 197                                 to the driver writer. Language is specified
 198                                 in RFC 4646 or ISO 639-2 language code format.
 199
 200   @param  DriverName[out]       A pointer to the Unicode string to return.
 201                                 This Unicode string is the name of the
 202                                 driver specified by This in the language
 203                                 specified by Language.
 204
 205   @retval EFI_SUCCESS           The Unicode string for the Driver specified by
 206                                 This and the language specified by Language was
 207                                 returned in DriverName.
 208
 209   @retval EFI_INVALID_PARAMETER Language is NULL.
 210
 211   @retval EFI_INVALID_PARAMETER DriverName is NULL.
 212
 213   @retval EFI_UNSUPPORTED       The driver specified by This does not support
 214                                 the language specified by Language.
 215
 216 **/
 217 EFI_STATUS
 218 EFIAPI
 219 SimpleNetworkComponentNameGetDriverName (
 220   IN  EFI_COMPONENT_NAME_PROTOCOL  *This,
 221   IN  CHAR8                        *Language,
 222   OUT CHAR16                       **DriverName
 223   )
 224 {
 225   return LookupUnicodeString2 (
 226            Language,
 227            This->SupportedLanguages,
 228            mSimpleNetworkDriverNameTable,
 229            DriverName,
 230            (BOOLEAN)(This == &gSimpleNetworkComponentName)
 231            );
 232 }
 233
 234 /**
 235   Retrieves a Unicode string that is the user readable name of the controller
 236   that is being managed by a driver.
 237
 238   This function retrieves the user readable name of the controller specified by
 239   ControllerHandle and ChildHandle in the form of a Unicode string. If the
 240   driver specified by This has a user readable name in the language specified by
 241   Language, then a pointer to the controller name is returned in ControllerName,
 242   and EFI_SUCCESS is returned.  If the driver specified by This is not currently
 243   managing the controller specified by ControllerHandle and ChildHandle,
 244   then EFI_UNSUPPORTED is returned.  If the driver specified by This does not
 245   support the language specified by Language, then EFI_UNSUPPORTED is returned.
 246   Currently not implemented.
 247
 248   @param  This[in]              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
 249                                 EFI_COMPONENT_NAME_PROTOCOL instance.
 250
 251   @param  ControllerHandle[in]  The handle of a controller that the driver
 252                                 specified by This is managing.  This handle
 253                                 specifies the controller whose name is to be
 254                                 returned.
 255
 256   @param  ChildHandle[in]       The handle of the child controller to retrieve
 257                                 the name of.  This is an optional parameter that
 258                                 may be NULL.  It will be NULL for device
 259                                 drivers.  It will also be NULL for a bus drivers
 260                                 that wish to retrieve the name of the bus
 261                                 controller.  It will not be NULL for a bus
 262                                 driver that wishes to retrieve the name of a
 263                                 child controller.
 264
 265   @param  Language[in]          A pointer to a Null-terminated ASCII string
 266                                 array indicating the language.  This is the
 267                                 language of the driver name that the caller is
 268                                 requesting, and it must match one of the
 269                                 languages specified in SupportedLanguages. The
 270                                 number of languages supported by a driver is up
 271                                 to the driver writer. Language is specified in
 272                                 RFC 4646 or ISO 639-2 language code format.
 273
 274   @param  ControllerName[out]   A pointer to the Unicode string to return.
 275                                 This Unicode string is the name of the
 276                                 controller specified by ControllerHandle and
 277                                 ChildHandle in the language specified by
 278                                 Language from the point of view of the driver
 279                                 specified by This.
 280
 281   @retval EFI_SUCCESS           The Unicode string for the user readable name in
 282                                 the language specified by Language for the
 283                                 driver specified by This was returned in
 284                                 DriverName.
 285
 286   @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.
 287
 288   @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid
 289                                 EFI_HANDLE.
 290
 291   @retval EFI_INVALID_PARAMETER Language is NULL.
 292
 293   @retval EFI_INVALID_PARAMETER ControllerName is NULL.
 294
 295   @retval EFI_UNSUPPORTED       The driver specified by This is not currently
 296                                 managing the controller specified by
 297                                 ControllerHandle and ChildHandle.
 298
 299   @retval EFI_UNSUPPORTED       The driver specified by This does not support
 300                                 the language specified by Language.
 301
 302 **/
 303 EFI_STATUS
 304 EFIAPI
 305 SimpleNetworkComponentNameGetControllerName (
 306   IN  EFI_COMPONENT_NAME_PROTOCOL                     *This,
 307   IN  EFI_HANDLE                                      ControllerHandle,
 308   IN  EFI_HANDLE                                      ChildHandle        OPTIONAL,
 309   IN  CHAR8                                           *Language,
 310   OUT CHAR16                                          **ControllerName
 311   )
 312 {
 313   return EFI_UNSUPPORTED;
 314 }