EdkModulePkg/Bus/Pci/PciBus/Dxe/PciLib.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   PciLib.h
  15
  16 Abstract:
  17
  18   PCI Bus Driver Lib header file.
  19   Please use PCD feature flag PcdPciBusHotplugDeviceSupport to enable
  20   support hot plug.
  21
  22 Revision History
  23
  24 --*/
  25
  26 #ifndef _EFI_PCI_LIB_H
  27 #define _EFI_PCI_LIB_H
  28
  29 VOID
  30 InstallHotPlugRequestProtocol (
  31   IN  EFI_STATUS                    *Status
  32   )
  33 /*++
  34
  35 Routine Description:
  36
  37   TODO: Add function description
  38
  39 Arguments:
  40
  41   Status  - TODO: add argument description
  42
  43 Returns:
  44
  45   TODO: add return values
  46
  47 --*/
  48 ;
  49
  50 VOID
  51 InstallPciHotplugGuid (
  52   IN  PCI_IO_DEVICE                  *PciIoDevice
  53   )
  54 /*++
  55
  56 Routine Description:
  57
  58   TODO: Add function description
  59
  60 Arguments:
  61
  62   PciIoDevice - TODO: add argument description
  63
  64 Returns:
  65
  66   TODO: add return values
  67
  68 --*/
  69 ;
  70
  71 VOID
  72 UninstallPciHotplugGuid (
  73   IN  PCI_IO_DEVICE                  *PciIoDevice
  74   )
  75 /*++
  76
  77 Routine Description:
  78
  79   TODO: Add function description
  80
  81 Arguments:
  82
  83   PciIoDevice - TODO: add argument description
  84
  85 Returns:
  86
  87   TODO: add return values
  88
  89 --*/
  90 ;
  91
  92 VOID
  93 GetBackPcCardBar (
  94   IN  PCI_IO_DEVICE                  *PciIoDevice
  95   )
  96 /*++
  97
  98 Routine Description:
  99
 100   TODO: Add function description
 101
 102 Arguments:
 103
 104   PciIoDevice - TODO: add argument description
 105
 106 Returns:
 107
 108   TODO: add return values
 109
 110 --*/
 111 ;
 112
 113 EFI_STATUS
 114 RemoveRejectedPciDevices (
 115   EFI_HANDLE        RootBridgeHandle,
 116   IN PCI_IO_DEVICE  *Bridge
 117   )
 118 /*++
 119
 120 Routine Description:
 121
 122   TODO: Add function description
 123
 124 Arguments:
 125
 126   RootBridgeHandle  - TODO: add argument description
 127   Bridge            - TODO: add argument description
 128
 129 Returns:
 130
 131   TODO: add return values
 132
 133 --*/
 134 ;
 135
 136 EFI_STATUS
 137 PciHostBridgeResourceAllocator (
 138   IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *PciResAlloc
 139   )
 140 /*++
 141
 142 Routine Description:
 143
 144   TODO: Add function description
 145
 146 Arguments:
 147
 148   PciResAlloc - TODO: add argument description
 149
 150 Returns:
 151
 152   TODO: add return values
 153
 154 --*/
 155 ;
 156
 157 EFI_STATUS
 158 PciHostBridgeResourceAllocator_WithoutHotPlugDeviceSupport (
 159   IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *PciResAlloc
 160   )
 161 ;
 162
 163 EFI_STATUS
 164 PciHostBridgeResourceAllocator_WithHotPlugDeviceSupport (
 165   IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *PciResAlloc
 166   )
 167 ;
 168
 169 EFI_STATUS
 170 PciScanBus (
 171   IN PCI_IO_DEVICE                      *Bridge,
 172   IN UINT8                              StartBusNumber,
 173   OUT UINT8                             *SubBusNumber,
 174   OUT UINT8                             *PaddedBusRange
 175   )
 176 /*++
 177
 178 Routine Description:
 179
 180   TODO: Add function description
 181
 182 Arguments:
 183
 184   Bridge          - TODO: add argument description
 185   StartBusNumber  - TODO: add argument description
 186   SubBusNumber    - TODO: add argument description
 187   PaddedBusRange  - TODO: add argument description
 188
 189 Returns:
 190
 191   TODO: add return values
 192
 193 --*/
 194 ;
 195
 196 EFI_STATUS
 197 PciScanBus_WithHotPlugDeviceSupport (
 198   IN PCI_IO_DEVICE                      *Bridge,
 199   IN UINT8                              StartBusNumber,
 200   OUT UINT8                             *SubBusNumber,
 201   OUT UINT8                             *PaddedBusRange
 202   )
 203 ;
 204
 205 EFI_STATUS
 206 PciScanBus_WithoutHotPlugDeviceSupport (
 207   IN PCI_IO_DEVICE                      *Bridge,
 208   IN UINT8                              StartBusNumber,
 209   OUT UINT8                             *SubBusNumber,
 210   OUT UINT8                             *PaddedBusRange
 211   )
 212 ;
 213
 214 EFI_STATUS
 215 PciRootBridgeP2CProcess (
 216   IN PCI_IO_DEVICE *Bridge
 217   )
 218 /*++
 219
 220 Routine Description:
 221
 222   TODO: Add function description
 223
 224 Arguments:
 225
 226   Bridge  - TODO: add argument description
 227
 228 Returns:
 229
 230   TODO: add return values
 231
 232 --*/
 233 ;
 234
 235 EFI_STATUS
 236 PciHostBridgeP2CProcess (
 237   IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *PciResAlloc
 238   )
 239 /*++
 240
 241 Routine Description:
 242
 243   TODO: Add function description
 244
 245 Arguments:
 246
 247   PciResAlloc - TODO: add argument description
 248
 249 Returns:
 250
 251   TODO: add return values
 252
 253 --*/
 254 ;
 255
 256 EFI_STATUS
 257 PciHostBridgeEnumerator (
 258   EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL  *PciResAlloc
 259   )
 260 /*++
 261
 262 Routine Description:
 263
 264   TODO: Add function description
 265
 266 Arguments:
 267
 268   PciResAlloc - TODO: add argument description
 269
 270 Returns:
 271
 272   TODO: add return values
 273
 274 --*/
 275 ;
 276
 277 #endif