MdeModulePkg/Universal/Network/Ip4ConfigDxe/ComponentName.c

   1 /** @file
   2
   3 Copyright (c) 2006 - 2007, Intel Corporation
   4 All rights reserved. This program and the accompanying materials
   5 are licensed and made available under the terms and conditions of the BSD License
   6 which accompanies this distribution.  The full text of the license may be found at
   7 http://opensource.org/licenses/bsd-license.php
   8
   9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  11
  12 Module Name:
  13
  14   ComponentName.c
  15
  16 Abstract:
  17
  18
  19 **/
  20
  21
  22 #include "Ip4Config.h"
  23
  24 //
  25 // EFI Component Name Functions
  26 //
  27 /**
  28   Retrieves a Unicode string that is the user readable name of the driver.
  29
  30   This function retrieves the user readable name of a driver in the form of a
  31   Unicode string. If the driver specified by This has a user readable name in
  32   the language specified by Language, then a pointer to the driver name is
  33   returned in DriverName, and EFI_SUCCESS is returned. If the driver specified
  34   by This does not support the language specified by Language,
  35   then EFI_UNSUPPORTED is returned.
  36
  37   @param  This[in]              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
  38                                 EFI_COMPONENT_NAME_PROTOCOL instance.
  39
  40   @param  Language[in]          A pointer to a Null-terminated ASCII string
  41                                 array indicating the language. This is the
  42                                 language of the driver name that the caller is
  43                                 requesting, and it must match one of the
  44                                 languages specified in SupportedLanguages. The
  45                                 number of languages supported by a driver is up
  46                                 to the driver writer. Language is specified
  47                                 in RFC 3066 or ISO 639-2 language code format.
  48
  49   @param  DriverName[out]       A pointer to the Unicode string to return.
  50                                 This Unicode string is the name of the
  51                                 driver specified by This in the language
  52                                 specified by Language.
  53
  54   @retval EFI_SUCCESS           The Unicode string for the Driver specified by
  55                                 This and the language specified by Language was
  56                                 returned in DriverName.
  57
  58   @retval EFI_INVALID_PARAMETER Language is NULL.
  59
  60   @retval EFI_INVALID_PARAMETER DriverName is NULL.
  61
  62   @retval EFI_UNSUPPORTED       The driver specified by This does not support
  63                                 the language specified by Language.
  64
  65 **/
  66 EFI_STATUS
  67 EFIAPI
  68 Ip4ConfigComponentNameGetDriverName (
  69   IN  EFI_COMPONENT_NAME_PROTOCOL  *This,
  70   IN  CHAR8                        *Language,
  71   OUT CHAR16                       **DriverName
  72   );
  73
  74
  75 /**
  76   Retrieves a Unicode string that is the user readable name of the controller
  77   that is being managed by a driver.
  78
  79   This function retrieves the user readable name of the controller specified by
  80   ControllerHandle and ChildHandle in the form of a Unicode string. If the
  81   driver specified by This has a user readable name in the language specified by
  82   Language, then a pointer to the controller name is returned in ControllerName,
  83   and EFI_SUCCESS is returned.  If the driver specified by This is not currently
  84   managing the controller specified by ControllerHandle and ChildHandle,
  85   then EFI_UNSUPPORTED is returned.  If the driver specified by This does not
  86   support the language specified by Language, then EFI_UNSUPPORTED is returned.
  87
  88   @param  This[in]              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
  89                                 EFI_COMPONENT_NAME_PROTOCOL instance.
  90
  91   @param  ControllerHandle[in]  The handle of a controller that the driver
  92                                 specified by This is managing.  This handle
  93                                 specifies the controller whose name is to be
  94                                 returned.
  95
  96   @param  ChildHandle[in]       The handle of the child controller to retrieve
  97                                 the name of.  This is an optional parameter that
  98                                 may be NULL.  It will be NULL for device
  99                                 drivers.  It will also be NULL for a bus drivers
 100                                 that wish to retrieve the name of the bus
 101                                 controller.  It will not be NULL for a bus
 102                                 driver that wishes to retrieve the name of a
 103                                 child controller.
 104
 105   @param  Language[in]          A pointer to a Null-terminated ASCII string
 106                                 array indicating the language.  This is the
 107                                 language of the driver name that the caller is
 108                                 requesting, and it must match one of the
 109                                 languages specified in SupportedLanguages. The
 110                                 number of languages supported by a driver is up
 111                                 to the driver writer. Language is specified in
 112                                 RFC 3066 or ISO 639-2 language code format.
 113
 114   @param  ControllerName[out]   A pointer to the Unicode string to return.
 115                                 This Unicode string is the name of the
 116                                 controller specified by ControllerHandle and
 117                                 ChildHandle in the language specified by
 118                                 Language from the point of view of the driver
 119                                 specified by This.
 120
 121   @retval EFI_SUCCESS           The Unicode string for the user readable name in
 122                                 the language specified by Language for the
 123                                 driver specified by This was returned in
 124                                 DriverName.
 125
 126   @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.
 127
 128   @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid
 129                                 EFI_HANDLE.
 130
 131   @retval EFI_INVALID_PARAMETER Language is NULL.
 132
 133   @retval EFI_INVALID_PARAMETER ControllerName is NULL.
 134
 135   @retval EFI_UNSUPPORTED       The driver specified by This is not currently
 136                                 managing the controller specified by
 137                                 ControllerHandle and ChildHandle.
 138
 139   @retval EFI_UNSUPPORTED       The driver specified by This does not support
 140                                 the language specified by Language.
 141
 142 **/
 143 EFI_STATUS
 144 EFIAPI
 145 Ip4ConfigComponentNameGetControllerName (
 146   IN  EFI_COMPONENT_NAME_PROTOCOL                     *This,
 147   IN  EFI_HANDLE                                      ControllerHandle,
 148   IN  EFI_HANDLE                                      ChildHandle        OPTIONAL,
 149   IN  CHAR8                                           *Language,
 150   OUT CHAR16                                          **ControllerName
 151   );
 152
 153
 154 //
 155 // EFI Component Name Protocol
 156 //
 157 GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL  gIp4ConfigComponentName = {
 158   Ip4ConfigComponentNameGetDriverName,
 159   Ip4ConfigComponentNameGetControllerName,
 160   "eng"
 161 };
 162
 163 //
 164 // EFI Component Name 2 Protocol
 165 //
 166 GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL gIp4ConfigComponentName2 = {
 167   (EFI_COMPONENT_NAME2_GET_DRIVER_NAME) Ip4ConfigComponentNameGetDriverName,
 168   (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) Ip4ConfigComponentNameGetControllerName,
 169   "en"
 170 };
 171
 172
 173 GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mIp4ConfigDriverNameTable[] = {
 174   {"eng;en", L"IP4 CONFIG Network Service Driver"},
 175   {NULL, NULL}
 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 3066 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 Ip4ConfigComponentNameGetDriverName (
 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            mIp4ConfigDriverNameTable,
 229            DriverName,
 230            (BOOLEAN)(This == &gIp4ConfigComponentName)
 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
 247   @param  This[in]              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
 248                                 EFI_COMPONENT_NAME_PROTOCOL instance.
 249
 250   @param  ControllerHandle[in]  The handle of a controller that the driver
 251                                 specified by This is managing.  This handle
 252                                 specifies the controller whose name is to be
 253                                 returned.
 254
 255   @param  ChildHandle[in]       The handle of the child controller to retrieve
 256                                 the name of.  This is an optional parameter that
 257                                 may be NULL.  It will be NULL for device
 258                                 drivers.  It will also be NULL for a bus drivers
 259                                 that wish to retrieve the name of the bus
 260                                 controller.  It will not be NULL for a bus
 261                                 driver that wishes to retrieve the name of a
 262                                 child controller.
 263
 264   @param  Language[in]          A pointer to a Null-terminated ASCII string
 265                                 array indicating the language.  This is the
 266                                 language of the driver name that the caller is
 267                                 requesting, and it must match one of the
 268                                 languages specified in SupportedLanguages. The
 269                                 number of languages supported by a driver is up
 270                                 to the driver writer. Language is specified in
 271                                 RFC 3066 or ISO 639-2 language code format.
 272
 273   @param  ControllerName[out]   A pointer to the Unicode string to return.
 274                                 This Unicode string is the name of the
 275                                 controller specified by ControllerHandle and
 276                                 ChildHandle in the language specified by
 277                                 Language from the point of view of the driver
 278                                 specified by This.
 279
 280   @retval EFI_SUCCESS           The Unicode string for the user readable name in
 281                                 the language specified by Language for the
 282                                 driver specified by This was returned in
 283                                 DriverName.
 284
 285   @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.
 286
 287   @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid
 288                                 EFI_HANDLE.
 289
 290   @retval EFI_INVALID_PARAMETER Language is NULL.
 291
 292   @retval EFI_INVALID_PARAMETER ControllerName is NULL.
 293
 294   @retval EFI_UNSUPPORTED       The driver specified by This is not currently
 295                                 managing the controller specified by
 296                                 ControllerHandle and ChildHandle.
 297
 298   @retval EFI_UNSUPPORTED       The driver specified by This does not support
 299                                 the language specified by Language.
 300
 301 **/
 302 EFI_STATUS
 303 EFIAPI
 304 Ip4ConfigComponentNameGetControllerName (
 305   IN  EFI_COMPONENT_NAME_PROTOCOL                     *This,
 306   IN  EFI_HANDLE                                      ControllerHandle,
 307   IN  EFI_HANDLE                                      ChildHandle        OPTIONAL,
 308   IN  CHAR8                                           *Language,
 309   OUT CHAR16                                          **ControllerName
 310   )
 311 {
 312   return EFI_UNSUPPORTED;
 313 }