Cleanup the license header

[mirror_edk2.git] / IntelFrameworkModulePkg / Bus / Isa / IsaSerialDxe / ComponentName.h

/**@file\r
\r
  \r
Copyright (c) 2006 - 2007, Intel Corporation.<BR>\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution.  The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#ifndef _SERIAL_COMPONENT_NAME_H\r
#define _SERIAL_COMPONENT_NAME_H\r
\r
#define SERIAL_PORT_NAME  "ISA Serial Port # "\r
#define ADD_SERIAL_NAME(x, y)    AddName ((x), (y))\r
\r
extern EFI_COMPONENT_NAME_PROTOCOL  gIsaSerialComponentName;\r
\r
//\r
// EFI Component Name Functions\r
//\r
EFI_STATUS\r
EFIAPI\r
IsaSerialComponentNameGetDriverName (\r
  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,\r
  IN  CHAR8                        *Language,\r
  OUT CHAR16                       **DriverName\r
  )\r
/*++\r
\r
  Routine Description:\r
\r
    Retrieves a Unicode string that is the user readable name of the EFI Driver.\r
\r
  Arguments:\r
\r
    This       - A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.\r
    Language   - A pointer to a three character ISO 639-2 language identifier.\r
                 This is the language of the driver name that that the caller\r
                 is requesting, and it must match one of the languages specified\r
                 in SupportedLanguages.  The number of languages supported by a\r
                 driver is up to the driver writer.\r
    DriverName - A pointer to the Unicode string to return.  This Unicode string\r
                 is the name of the driver specified by This in the language\r
                 specified by Language.\r
\r
  Returns:\r
\r
    EFI_SUCCESS           - The Unicode string for the Driver specified by This\r
                            and the language specified by Language was returned\r
                            in DriverName.\r
    EFI_INVALID_PARAMETER - Language is NULL.\r
    EFI_INVALID_PARAMETER - DriverName is NULL.\r
    EFI_UNSUPPORTED       - The driver specified by This does not support the\r
                            language specified by Language.\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
IsaSerialComponentNameGetControllerName (\r
  IN  EFI_COMPONENT_NAME_PROTOCOL                     *This,\r
  IN  EFI_HANDLE                                      ControllerHandle,\r
  IN  EFI_HANDLE                                      ChildHandle        OPTIONAL,\r
  IN  CHAR8                                           *Language,\r
  OUT CHAR16                                          **ControllerName\r
  )\r
/*++\r
\r
  Routine Description:\r
\r
    Retrieves a Unicode string that is the user readable name of the controller\r
    that is being managed by an EFI Driver.\r
\r
  Arguments:\r
\r
    This             - A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.\r
    ControllerHandle - The handle of a controller that the driver specified by\r
                       This is managing.  This handle specifies the controller\r
                       whose name is to be returned.\r
    ChildHandle      - The handle of the child controller to retrieve the name\r
                       of.  This is an optional parameter that may be NULL.  It\r
                       will be NULL for device drivers.  It will also be NULL\r
                       for a bus drivers that wish to retrieve the name of the\r
                       bus controller.  It will not be NULL for a bus driver\r
                       that wishes to retrieve the name of a child controller.\r
    Language         - A pointer to a three character ISO 639-2 language\r
                       identifier.  This is the language of the controller name\r
                       that that the caller is requesting, and it must match one\r
                       of the languages specified in SupportedLanguages.  The\r
                       number of languages supported by a driver is up to the\r
                       driver writer.\r
    ControllerName   - A pointer to the Unicode string to return.  This Unicode\r
                       string is the name of the controller specified by\r
                       ControllerHandle and ChildHandle in the language\r
                       specified by Language from the point of view of the\r
                       driver specified by This.\r
\r
  Returns:\r
\r
    EFI_SUCCESS           - The Unicode string for the user readable name in the\r
                            language specified by Language for the driver\r
                            specified by This was returned in DriverName.\r
    EFI_INVALID_PARAMETER - ControllerHandle is not a valid EFI_HANDLE.\r
    EFI_INVALID_PARAMETER - ChildHandle is not NULL and it is not a valid\r
                            EFI_HANDLE.\r
    EFI_INVALID_PARAMETER - Language is NULL.\r
    EFI_INVALID_PARAMETER - ControllerName is NULL.\r
    EFI_UNSUPPORTED       - The driver specified by This is not currently\r
                            managing the controller specified by\r
                            ControllerHandle and ChildHandle.\r
    EFI_UNSUPPORTED       - The driver specified by This does not support the\r
                            language specified by Language.\r
\r
--*/\r
;\r
\r
VOID\r
AddName (\r
  IN  SERIAL_DEV                                   *SerialDevice,\r
  IN  EFI_ISA_IO_PROTOCOL                          *IsaIo\r
  )\r
/*++\r
\r
  Routine Description:\r
\r
    Add the component name for the serial io device\r
\r
  Arguments:\r
\r
    SerialDevice              - A pointer to the SERIAL_DEV instance.\r
    IsaIo                     - A pointer to the EFI_ISA_IO_PROTOCOL instance.\r
\r
  Returns:\r
\r
    None\r
\r
--*/\r
;\r
\r
#endif\r