IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciHotPlugSupport.h

   1 /**@file
   2
   3 Copyright (c) 2006, Intel Corporation
   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
  14
  15 #ifndef _EFI_PCI_HOT_PLUG_SUPPORT_H
  16 #define _EFI_PCI_HOT_PLUG_SUPPORT_H
  17
  18
  19 //
  20 // stall 1 second
  21 //
  22 #define STALL_1_SECOND        1000000
  23
  24 typedef struct {
  25   EFI_EVENT Event;
  26   BOOLEAN   Initialized;
  27   VOID      *Padding;
  28 } ROOT_HPC_DATA;
  29
  30 extern EFI_PCI_HOT_PLUG_INIT_PROTOCOL *gPciHotPlugInit;
  31 extern EFI_HPC_LOCATION               *gPciRootHpcPool;
  32 extern UINTN                          gPciRootHpcCount;
  33 extern ROOT_HPC_DATA                  *gPciRootHpcData;
  34
  35 VOID
  36 EFIAPI
  37 PciHPCInitialized (
  38   IN EFI_EVENT    Event,
  39   IN VOID         *Context
  40   )
  41 /*++
  42
  43 Routine Description:
  44
  45   TODO: Add function description
  46
  47 Arguments:
  48
  49   Event   - TODO: add argument description
  50   Context - TODO: add argument description
  51
  52 Returns:
  53
  54   TODO: add return values
  55
  56 --*/
  57 ;
  58
  59 BOOLEAN
  60 EfiCompareDevicePath (
  61   IN EFI_DEVICE_PATH_PROTOCOL *DevicePath1,
  62   IN EFI_DEVICE_PATH_PROTOCOL *DevicePath2
  63   )
  64 /*++
  65
  66 Routine Description:
  67
  68   TODO: Add function description
  69
  70 Arguments:
  71
  72   DevicePath1 - TODO: add argument description
  73   DevicePath2 - TODO: add argument description
  74
  75 Returns:
  76
  77   TODO: add return values
  78
  79 --*/
  80 ;
  81
  82 EFI_STATUS
  83 InitializeHotPlugSupport (
  84   VOID
  85   )
  86 /*++
  87
  88 Routine Description:
  89
  90   TODO: Add function description
  91
  92 Arguments:
  93
  94   None
  95
  96 Returns:
  97
  98   TODO: add return values
  99
 100 --*/
 101 ;
 102
 103 EFI_STATUS
 104 IsPciHotPlugBus (
 105   PCI_IO_DEVICE                       *PciIoDevice
 106   )
 107 /*++
 108
 109 Routine Description:
 110
 111   TODO: Add function description
 112
 113 Arguments:
 114
 115   PciIoDevice - TODO: add argument description
 116
 117 Returns:
 118
 119   TODO: add return values
 120
 121 --*/
 122 ;
 123
 124 BOOLEAN
 125 IsRootPciHotPlugBus (
 126   IN EFI_DEVICE_PATH_PROTOCOL         *HpbDevicePath,
 127   OUT UINTN                           *HpIndex
 128   )
 129 /*++
 130
 131 Routine Description:
 132
 133   TODO: Add function description
 134
 135 Arguments:
 136
 137   HpbDevicePath - TODO: add argument description
 138   HpIndex       - TODO: add argument description
 139
 140 Returns:
 141
 142   TODO: add return values
 143
 144 --*/
 145 ;
 146
 147 BOOLEAN
 148 IsRootPciHotPlugController (
 149   IN EFI_DEVICE_PATH_PROTOCOL         *HpcDevicePath,
 150   OUT UINTN                           *HpIndex
 151   )
 152 /*++
 153
 154 Routine Description:
 155
 156   TODO: Add function description
 157
 158 Arguments:
 159
 160   HpcDevicePath - TODO: add argument description
 161   HpIndex       - TODO: add argument description
 162
 163 Returns:
 164
 165   TODO: add return values
 166
 167 --*/
 168 ;
 169
 170 EFI_STATUS
 171 CreateEventForHpc (
 172   IN UINTN       HpIndex,
 173   OUT EFI_EVENT  *Event
 174   )
 175 /*++
 176
 177 Routine Description:
 178
 179   TODO: Add function description
 180
 181 Arguments:
 182
 183   HpIndex - TODO: add argument description
 184   Event   - TODO: add argument description
 185
 186 Returns:
 187
 188   TODO: add return values
 189
 190 --*/
 191 ;
 192
 193 EFI_STATUS
 194 AllRootHPCInitialized (
 195   IN  UINTN           TimeoutInMicroSeconds
 196   )
 197 /*++
 198
 199 Routine Description:
 200
 201   TODO: Add function description
 202
 203 Arguments:
 204   TimeoutInMicroSeconds - microseconds to wait for all root hpc's initialization
 205
 206 Returns:
 207   EFI_SUCCESS - All root hpc's initialization is finished before the timeout
 208   EFI_TIMEOUT - Time out
 209
 210 --*/
 211 ;
 212
 213 EFI_STATUS
 214 IsSHPC (
 215   PCI_IO_DEVICE                       *PciIoDevice
 216   )
 217 /*++
 218
 219 Routine Description:
 220
 221   TODO: Add function description
 222
 223 Arguments:
 224
 225   PciIoDevice - TODO: add argument description
 226
 227 Returns:
 228
 229   TODO: add return values
 230
 231 --*/
 232 ;
 233
 234 EFI_STATUS
 235 GetResourcePaddingForHpb (
 236   IN PCI_IO_DEVICE *PciIoDevice
 237   )
 238 /*++
 239
 240 Routine Description:
 241
 242   TODO: Add function description
 243
 244 Arguments:
 245
 246   PciIoDevice - TODO: add argument description
 247
 248 Returns:
 249
 250   TODO: add return values
 251
 252 --*/
 253 ;
 254
 255 #endif