MdeModulePkg/Bus/Isa/IsaBusDxe/ComponentName.h

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