EdkModulePkg/Bus/Pci/IdeBus/Dxe/ComponentName.h

   1 /** @file
   2   Copyright (c) 2006, Intel Corporation
   3   All rights reserved. This program and the accompanying materials
   4   are licensed and made available under the terms and conditions of the BSD License
   5   which accompanies this distribution.  The full text of the license may be found at
   6   http://opensource.org/licenses/bsd-license.php
   7
   8   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
   9   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  10
  11 **/
  12
  13 #ifndef _IDE_BUS_COMPONENT_NAME_H
  14 #define _IDE_BUS_COMPONENT_NAME_H
  15
  16
  17 #ifndef EFI_SIZE_REDUCTION_APPLIED
  18
  19 #define ADD_NAME(x) AddName ((x));
  20
  21 extern EFI_COMPONENT_NAME_PROTOCOL  gIDEBusComponentName;
  22
  23 #else
  24
  25 #define ADD_NAME(x)
  26
  27 #endif
  28
  29
  30 //
  31 // EFI Component Name Functions
  32 //
  33 /**
  34   TODO: Add function description
  35
  36   @param  This TODO: add argument description
  37   @param  Language TODO: add argument description
  38   @param  DriverName TODO: add argument description
  39
  40   TODO: add return values
  41
  42 **/
  43 EFI_STATUS
  44 EFIAPI
  45 IDEBusComponentNameGetDriverName (
  46   IN  EFI_COMPONENT_NAME_PROTOCOL  *This,
  47   IN  CHAR8                        *Language,
  48   OUT CHAR16                       **DriverName
  49   )
  50 ;
  51
  52 /**
  53   TODO: Add function description
  54
  55   @param  This TODO: add argument description
  56   @param  ControllerHandle TODO: add argument description
  57   @param  ChildHandle TODO: add argument description
  58   @param  Language TODO: add argument description
  59   @param  ControllerName TODO: add argument description
  60
  61   TODO: add return values
  62
  63 **/
  64 EFI_STATUS
  65 EFIAPI
  66 IDEBusComponentNameGetControllerName (
  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 /**
  76   TODO: Add function description
  77
  78   @param  IdeBlkIoDevicePtr TODO: add argument description
  79
  80   TODO: add return values
  81
  82 **/
  83 VOID
  84 AddName (
  85   IN  IDE_BLK_IO_DEV               *IdeBlkIoDevicePtr
  86   )
  87 ;
  88
  89 #endif