IntelFrameworkModulePkg/Bus/Isa/IsaSerialDxe/ComponentName.h

   1 /**@file
   2
   3
   4 Copyright (c) 2006 - 2007, Intel Corporation.<BR>
   5 All rights reserved. This program and the accompanying materials
   6 are licensed and made available under the terms and conditions of the BSD License
   7 which accompanies this distribution.  The full text of the license may be found at
   8 http://opensource.org/licenses/bsd-license.php
   9
  10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef _SERIAL_COMPONENT_NAME_H
  16 #define _SERIAL_COMPONENT_NAME_H
  17
  18 #define SERIAL_PORT_NAME  "ISA Serial Port # "
  19 #define ADD_SERIAL_NAME(x, y)    AddName ((x), (y))
  20
  21 extern EFI_COMPONENT_NAME_PROTOCOL  gIsaSerialComponentName;
  22
  23 //
  24 // EFI Component Name Functions
  25 //
  26 EFI_STATUS
  27 EFIAPI
  28 IsaSerialComponentNameGetDriverName (
  29   IN  EFI_COMPONENT_NAME_PROTOCOL  *This,
  30   IN  CHAR8                        *Language,
  31   OUT CHAR16                       **DriverName
  32   )
  33 /*++
  34
  35   Routine Description:
  36
  37     Retrieves a Unicode string that is the user readable name of the EFI Driver.
  38
  39   Arguments:
  40
  41     This       - A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
  42     Language   - A pointer to a three character ISO 639-2 language identifier.
  43                  This is the language of the driver name that that the caller
  44                  is requesting, and it must match one of the languages specified
  45                  in SupportedLanguages.  The number of languages supported by a
  46                  driver is up to the driver writer.
  47     DriverName - A pointer to the Unicode string to return.  This Unicode string
  48                  is the name of the driver specified by This in the language
  49                  specified by Language.
  50
  51   Returns:
  52
  53     EFI_SUCCESS           - The Unicode string for the Driver specified by This
  54                             and the language specified by Language was returned
  55                             in DriverName.
  56     EFI_INVALID_PARAMETER - Language is NULL.
  57     EFI_INVALID_PARAMETER - DriverName is NULL.
  58     EFI_UNSUPPORTED       - The driver specified by This does not support the
  59                             language specified by Language.
  60
  61 --*/
  62 ;
  63
  64 EFI_STATUS
  65 EFIAPI
  66 IsaSerialComponentNameGetControllerName (
  67   IN  EFI_COMPONENT_NAME_PROTOCOL                     *This,
  68   IN  EFI_HANDLE                                      ControllerHandle,
  69   IN  EFI_HANDLE                                      ChildHandle        OPTIONAL,
  70   IN  CHAR8                                           *Language,
  71   OUT CHAR16                                          **ControllerName
  72   )
  73 /*++
  74
  75   Routine Description:
  76
  77     Retrieves a Unicode string that is the user readable name of the controller
  78     that is being managed by an EFI Driver.
  79
  80   Arguments:
  81
  82     This             - A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
  83     ControllerHandle - The handle of a controller that the driver specified by
  84                        This is managing.  This handle specifies the controller
  85                        whose name is to be returned.
  86     ChildHandle      - The handle of the child controller to retrieve the name
  87                        of.  This is an optional parameter that may be NULL.  It
  88                        will be NULL for device drivers.  It will also be NULL
  89                        for a bus drivers that wish to retrieve the name of the
  90                        bus controller.  It will not be NULL for a bus driver
  91                        that wishes to retrieve the name of a child controller.
  92     Language         - A pointer to a three character ISO 639-2 language
  93                        identifier.  This is the language of the controller name
  94                        that that the caller is requesting, and it must match one
  95                        of the languages specified in SupportedLanguages.  The
  96                        number of languages supported by a driver is up to the
  97                        driver writer.
  98     ControllerName   - A pointer to the Unicode string to return.  This Unicode
  99                        string is the name of the controller specified by
 100                        ControllerHandle and ChildHandle in the language
 101                        specified by Language from the point of view of the
 102                        driver specified by This.
 103
 104   Returns:
 105
 106     EFI_SUCCESS           - The Unicode string for the user readable name in the
 107                             language specified by Language for the driver
 108                             specified by This was returned in DriverName.
 109     EFI_INVALID_PARAMETER - ControllerHandle is not a valid EFI_HANDLE.
 110     EFI_INVALID_PARAMETER - ChildHandle is not NULL and it is not a valid
 111                             EFI_HANDLE.
 112     EFI_INVALID_PARAMETER - Language is NULL.
 113     EFI_INVALID_PARAMETER - ControllerName is NULL.
 114     EFI_UNSUPPORTED       - The driver specified by This is not currently
 115                             managing the controller specified by
 116                             ControllerHandle and ChildHandle.
 117     EFI_UNSUPPORTED       - The driver specified by This does not support the
 118                             language specified by Language.
 119
 120 --*/
 121 ;
 122
 123 VOID
 124 AddName (
 125   IN  SERIAL_DEV                                   *SerialDevice,
 126   IN  EFI_ISA_IO_PROTOCOL                          *IsaIo
 127   )
 128 /*++
 129
 130   Routine Description:
 131
 132     Add the component name for the serial io device
 133
 134   Arguments:
 135
 136     SerialDevice              - A pointer to the SERIAL_DEV instance.
 137     IsaIo                     - A pointer to the EFI_ISA_IO_PROTOCOL instance.
 138
 139   Returns:
 140
 141     None
 142
 143 --*/
 144 ;
 145
 146 #endif