IntelFrameworkModulePkg/Bus/Isa/IsaSerialDxe/ComponentName.h

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