QuarkSocPkg/QuarkSouthCluster/Sdio/Dxe/SDControllerDxe/ComponentName.h

   1 /** @file
   2
   3 This file contains the delarations for componet name routines.
   4
   5 Copyright (c) 2013-2015 Intel Corporation.
   6
   7 This program and the accompanying materials
   8 are licensed and made available under the terms and conditions of the BSD License
   9 which accompanies this distribution.  The full text of the license may be found at
  10 http://opensource.org/licenses/bsd-license.php
  11
  12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  14
  15 **/
  16
  17
  18 #ifndef _COMPONENT_NAME_H_
  19 #define _COMPONENT_NAME_H_
  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 3066 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 SDControllerGetDriverName (
  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 3066 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 SDControllerGetControllerName (
 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 #endif