EdkModulePkg/Bus/Pci/PciBus/Dxe/PciHotPlugSupport.h

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