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 SPDX-License-Identifier: BSD-2-Clause-Patent
   8
   9 **/
  10
  11
  12 #ifndef _COMPONENT_NAME_H_
  13 #define _COMPONENT_NAME_H_
  14
  15 /**
  16   Retrieves a Unicode string that is the user readable name of the driver.
  17
  18   This function retrieves the user readable name of a driver in the form of a
  19   Unicode string. If the driver specified by This has a user readable name in
  20   the language specified by Language, then a pointer to the driver name is
  21   returned in DriverName, and EFI_SUCCESS is returned. If the driver specified
  22   by This does not support the language specified by Language,
  23   then EFI_UNSUPPORTED is returned.
  24
  25   @param  This[in]              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
  26                                 EFI_COMPONENT_NAME_PROTOCOL instance.
  27
  28   @param  Language[in]          A pointer to a Null-terminated ASCII string
  29                                 array indicating the language. This is the
  30                                 language of the driver name that the caller is
  31                                 requesting, and it must match one of the
  32                                 languages specified in SupportedLanguages. The
  33                                 number of languages supported by a driver is up
  34                                 to the driver writer. Language is specified
  35                                 in RFC 3066 or ISO 639-2 language code format.
  36
  37   @param  DriverName[out]       A pointer to the Unicode string to return.
  38                                 This Unicode string is the name of the
  39                                 driver specified by This in the language
  40                                 specified by Language.
  41
  42   @retval EFI_SUCCESS           The Unicode string for the Driver specified by
  43                                 This and the language specified by Language was
  44                                 returned in DriverName.
  45
  46   @retval EFI_INVALID_PARAMETER Language is NULL.
  47
  48   @retval EFI_INVALID_PARAMETER DriverName is NULL.
  49
  50   @retval EFI_UNSUPPORTED       The driver specified by This does not support
  51                                 the language specified by Language.
  52
  53 **/
  54 EFI_STATUS
  55 EFIAPI
  56 SDControllerGetDriverName (
  57   IN  EFI_COMPONENT_NAME_PROTOCOL  *This,
  58   IN  CHAR8                        *Language,
  59   OUT CHAR16                       **DriverName
  60   );
  61
  62
  63 /**
  64   Retrieves a Unicode string that is the user readable name of the controller
  65   that is being managed by a driver.
  66
  67   This function retrieves the user readable name of the controller specified by
  68   ControllerHandle and ChildHandle in the form of a Unicode string. If the
  69   driver specified by This has a user readable name in the language specified by
  70   Language, then a pointer to the controller name is returned in ControllerName,
  71   and EFI_SUCCESS is returned.  If the driver specified by This is not currently
  72   managing the controller specified by ControllerHandle and ChildHandle,
  73   then EFI_UNSUPPORTED is returned.  If the driver specified by This does not
  74   support the language specified by Language, then EFI_UNSUPPORTED is returned.
  75
  76   @param  This[in]              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
  77                                 EFI_COMPONENT_NAME_PROTOCOL instance.
  78
  79   @param  ControllerHandle[in]  The handle of a controller that the driver
  80                                 specified by This is managing.  This handle
  81                                 specifies the controller whose name is to be
  82                                 returned.
  83
  84   @param  ChildHandle[in]       The handle of the child controller to retrieve
  85                                 the name of.  This is an optional parameter that
  86                                 may be NULL.  It will be NULL for device
  87                                 drivers.  It will also be NULL for a bus drivers
  88                                 that wish to retrieve the name of the bus
  89                                 controller.  It will not be NULL for a bus
  90                                 driver that wishes to retrieve the name of a
  91                                 child controller.
  92
  93   @param  Language[in]          A pointer to a Null-terminated ASCII string
  94                                 array indicating the language.  This is the
  95                                 language of the driver name that the caller is
  96                                 requesting, and it must match one of the
  97                                 languages specified in SupportedLanguages. The
  98                                 number of languages supported by a driver is up
  99                                 to the driver writer. Language is specified in
 100                                 RFC 3066 or ISO 639-2 language code format.
 101
 102   @param  ControllerName[out]   A pointer to the Unicode string to return.
 103                                 This Unicode string is the name of the
 104                                 controller specified by ControllerHandle and
 105                                 ChildHandle in the language specified by
 106                                 Language from the point of view of the driver
 107                                 specified by This.
 108
 109   @retval EFI_SUCCESS           The Unicode string for the user readable name in
 110                                 the language specified by Language for the
 111                                 driver specified by This was returned in
 112                                 DriverName.
 113
 114   @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.
 115
 116   @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid
 117                                 EFI_HANDLE.
 118
 119   @retval EFI_INVALID_PARAMETER Language is NULL.
 120
 121   @retval EFI_INVALID_PARAMETER ControllerName is NULL.
 122
 123   @retval EFI_UNSUPPORTED       The driver specified by This is not currently
 124                                 managing the controller specified by
 125                                 ControllerHandle and ChildHandle.
 126
 127   @retval EFI_UNSUPPORTED       The driver specified by This does not support
 128                                 the language specified by Language.
 129
 130 **/
 131 EFI_STATUS
 132 EFIAPI
 133 SDControllerGetControllerName (
 134   IN  EFI_COMPONENT_NAME_PROTOCOL                     *This,
 135   IN  EFI_HANDLE                                      ControllerHandle,
 136   IN  EFI_HANDLE                                      ChildHandle        OPTIONAL,
 137   IN  CHAR8                                           *Language,
 138   OUT CHAR16                                          **ControllerName
 139   );
 140
 141 #endif