DuetPkg/IdeControllerDxe/ComponentName.h

   1 /*++
   2
   3 Copyright (c) 2006 - 2007 Intel Corporation. All rights reserved
   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
  13 Module Name:
  14
  15   ComponentName.h
  16
  17 Abstract:
  18
  19
  20 Revision History
  21 --*/
  22
  23 #ifndef _IDE_CONTROLLER_COMPONENT_NAME_H
  24 #define _IDE_CONTROLLER_COMPONENT_NAME_H
  25
  26 #ifndef EFI_SIZE_REDUCTION_APPLIED
  27
  28 #include "Tiano.h"
  29 #include EFI_PROTOCOL_DEFINITION (ComponentName)
  30 #include EFI_PROTOCOL_DEFINITION (ComponentName2)
  31
  32 //
  33 // Global Variables definitions
  34 //
  35 #if (EFI_SPECIFICATION_VERSION >= 0x00020000)
  36 extern EFI_COMPONENT_NAME2_PROTOCOL gIdeControllerName;
  37 #else
  38 extern EFI_COMPONENT_NAME_PROTOCOL  gIdeControllerName;
  39 #endif
  40
  41 //
  42 // Forward reference declaration
  43 //
  44 EFI_STATUS
  45 EFIAPI
  46 IdeControllerGetDriverName (
  47 #if (EFI_SPECIFICATION_VERSION >= 0x00020000)
  48   IN  EFI_COMPONENT_NAME2_PROTOCOL *This,
  49 #else
  50   IN  EFI_COMPONENT_NAME_PROTOCOL  *This,
  51 #endif
  52   IN  CHAR8                        *Language,
  53   OUT CHAR16                       **DriverName
  54   )
  55 /*++
  56
  57   Routine Description:
  58     Retrieves a Unicode string that is the user readable name of the EFI Driver.
  59
  60   Arguments:
  61     This       - A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
  62     Language   - A pointer to a three character ISO 639-2 language identifier.
  63                  This is the language of the driver name that that the caller
  64                  is requesting, and it must match one of the languages specified
  65                  in SupportedLanguages.  The number of languages supported by a
  66                  driver is up to the driver writer.
  67     DriverName - A pointer to the Unicode string to return.  This Unicode string
  68                  is the name of the driver specified by This in the language
  69                  specified by Language.
  70
  71   Returns:
  72     EFI_SUCCESS           - The Unicode string for the Driver specified by This
  73                             and the language specified by Language was returned
  74                             in DriverName.
  75     EFI_INVALID_PARAMETER - Language is NULL.
  76     EFI_INVALID_PARAMETER - DriverName is NULL.
  77     EFI_UNSUPPORTED       - The driver specified by This does not support the
  78                             language specified by Language.
  79
  80 --*/
  81 ;
  82
  83 EFI_STATUS
  84 EFIAPI
  85 IdeControllerGetControllerName (
  86 #if (EFI_SPECIFICATION_VERSION >= 0x00020000)
  87   IN  EFI_COMPONENT_NAME2_PROTOCOL                    *This,
  88 #else
  89   IN  EFI_COMPONENT_NAME_PROTOCOL                     *This,
  90 #endif
  91   IN  EFI_HANDLE                                      ControllerHandle,
  92   IN  EFI_HANDLE                                      ChildHandle        OPTIONAL,
  93   IN  CHAR8                                           *Language,
  94   OUT CHAR16                                          **ControllerName
  95   )
  96 /*++
  97
  98   Routine Description:
  99     Retrieves a Unicode string that is the user readable name of the controller
 100     that is being managed by an EFI Driver.
 101
 102   Arguments:
 103     This             - A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
 104     ControllerHandle - The handle of a controller that the driver specified by
 105                        This is managing.  This handle specifies the controller
 106                        whose name is to be returned.
 107     ChildHandle      - The handle of the child controller to retrieve the name
 108                        of.  This is an optional parameter that may be NULL.  It
 109                        will be NULL for device drivers.  It will also be NULL
 110                        for a bus drivers that wish to retrieve the name of the
 111                        bus controller.  It will not be NULL for a bus driver
 112                        that wishes to retrieve the name of a child controller.
 113     Language         - A pointer to a three character ISO 639-2 language
 114                        identifier.  This is the language of the controller name
 115                        that that the caller is requesting, and it must match one
 116                        of the languages specified in SupportedLanguages.  The
 117                        number of languages supported by a driver is up to the
 118                        driver writer.
 119     ControllerName   - A pointer to the Unicode string to return.  This Unicode
 120                        string is the name of the controller specified by
 121                        ControllerHandle and ChildHandle in the language
 122                        specified by Language from the point of view of the
 123                        driver specified by This.
 124
 125   Returns:
 126     EFI_SUCCESS           - The Unicode string for the user readable name in the
 127                             language specified by Language for the driver
 128                             specified by This was returned in DriverName.
 129     EFI_INVALID_PARAMETER - ControllerHandle is not a valid EFI_HANDLE.
 130     EFI_INVALID_PARAMETER - ChildHandle is not NULL and it is not a valid
 131                             EFI_HANDLE.
 132     EFI_INVALID_PARAMETER - Language is NULL.
 133     EFI_INVALID_PARAMETER - ControllerName is NULL.
 134     EFI_UNSUPPORTED       - The driver specified by This is not currently
 135                             managing the controller specified by
 136                             ControllerHandle and ChildHandle.
 137     EFI_UNSUPPORTED       - The driver specified by This does not support the
 138                             language specified by Language.
 139
 140 --*/
 141 ;
 142
 143 #endif
 144
 145 #endif