Add function doxygen header for PciBus module.

[mirror_edk2.git] / IntelFrameworkModulePkg / Bus / Pci / PciBusDxe / PciHotPlugSupport.h

/**@file\r
\r
Copyright (c) 2006, Intel Corporation                                                         \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
\r
#ifndef _EFI_PCI_HOT_PLUG_SUPPORT_H\r
#define _EFI_PCI_HOT_PLUG_SUPPORT_H\r
\r
\r
//\r
// stall 1 second\r
//\r
#define STALL_1_SECOND        1000000 \r
\r
typedef struct {\r
  EFI_EVENT Event;\r
  BOOLEAN   Initialized;\r
  VOID      *Padding;\r
} ROOT_HPC_DATA;\r
\r
extern EFI_PCI_HOT_PLUG_INIT_PROTOCOL *gPciHotPlugInit;\r
extern EFI_HPC_LOCATION               *gPciRootHpcPool;\r
extern UINTN                          gPciRootHpcCount;\r
extern ROOT_HPC_DATA                  *gPciRootHpcData;\r
\r
/**\r
  Init HPC private data.\r
  \r
  @param  Event     event object\r
  @param  Context   HPC private data.\r
**/\r
VOID\r
EFIAPI\r
PciHPCInitialized (\r
  IN EFI_EVENT    Event,\r
  IN VOID         *Context\r
  )\r
;\r
\r
/**\r
  Compare two device path\r
  \r
  @param DevicePath1    the first device path want to be compared\r
  @param DevicePath2    the first device path want to be compared\r
  \r
  @retval TRUE    equal\r
  @retval FALSE   different\r
**/\r
BOOLEAN\r
EfiCompareDevicePath (\r
  IN EFI_DEVICE_PATH_PROTOCOL *DevicePath1,\r
  IN EFI_DEVICE_PATH_PROTOCOL *DevicePath2\r
  )\r
;\r
\r
/**\r
  Init hot plug support and root hot plug private data.\r
  \r
**/\r
EFI_STATUS\r
InitializeHotPlugSupport (\r
  VOID\r
  )\r
;\r
\r
/**\r
  Test whether PCI device is hot plug bus.\r
  \r
  @param PciIoDevice  PCI device instance\r
  \r
  @retval EFI_SUCCESS   PCI device is hot plug bus\r
  @retval EFI_NOT_FOUND PCI device is not hot plug bus\r
**/\r
EFI_STATUS\r
IsPciHotPlugBus (\r
  PCI_IO_DEVICE                       *PciIoDevice\r
  )\r
;\r
\r
/**\r
  Test whether device path is for root pci hot plug bus\r
  \r
  @param HpbdevicePath  tested device path\r
  @param HpIndex        Return the index of root hot plug in global array.\r
  \r
  @retval TRUE  device path is for root pci hot plug\r
  @retval FALSE device path is not for root pci hot plug\r
**/\r
BOOLEAN\r
IsRootPciHotPlugBus (\r
  IN EFI_DEVICE_PATH_PROTOCOL         *HpbDevicePath,\r
  OUT UINTN                           *HpIndex\r
  )\r
;\r
\r
/**\r
  Test whether device path is for root pci hot plug controller\r
  \r
  @param HpbdevicePath  tested device path\r
  @param HpIndex        Return the index of root hot plug in global array.\r
  \r
  @retval TRUE  device path is for root pci hot plug controller\r
  @retval FALSE device path is not for root pci hot plug controller\r
**/\r
BOOLEAN\r
IsRootPciHotPlugController (\r
  IN EFI_DEVICE_PATH_PROTOCOL         *HpcDevicePath,\r
  OUT UINTN                           *HpIndex\r
  )\r
;\r
\r
/**\r
  Wrapper for creating event object for HPC \r
  \r
  @param  HpIndex   index of hot plug device in global array\r
  @param  Event     event object\r
  \r
  @return status of create event invoken\r
**/\r
EFI_STATUS\r
CreateEventForHpc (\r
  IN UINTN       HpIndex,\r
  OUT EFI_EVENT  *Event\r
  )\r
;\r
\r
/**\r
  Wait for all root HPC initialized.\r
  \r
  @param TimeoutInMicroSeconds  microseconds to wait for all root hpc's initialization\r
**/\r
EFI_STATUS\r
AllRootHPCInitialized (\r
  IN  UINTN           TimeoutInMicroSeconds\r
  )\r
;\r
\r
/**\r
  Check HPC capability register block\r
  \r
  @param PciIoDevice PCI device instance\r
  \r
  @retval EFI_SUCCESS   PCI device is HPC\r
  @retval EFI_NOT_FOUND PCI device is not HPC\r
**/\r
EFI_STATUS\r
IsSHPC (\r
  PCI_IO_DEVICE                       *PciIoDevice\r
  )\r
;\r
\r
/**\r
  Get resource padding for hot plug bus\r
  \r
  @param PciIoDevice PCI device instance\r
  \r
  @retval EFI_SUCCESS   success get padding and set it into PCI device instance\r
  @retval EFI_NOT_FOUND PCI device is not a hot plug bus.\r
**/\r
EFI_STATUS\r
GetResourcePaddingForHpb (\r
  IN PCI_IO_DEVICE *PciIoDevice\r
  )\r
;\r
\r
#endif\r