MdeModulePkg/Bus/Pci/UhciDxe/ComponentName.h

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