EdkModulePkg/Bus/Pci/PciBus/Dxe/PciDeviceSupport.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   PciDeviceSupport.h
  15
  16 Abstract:
  17
  18
  19
  20 Revision History
  21
  22 --*/
  23
  24 #ifndef _EFI_PCI_DEVICE_SUPPORT_H
  25 #define _EFI_PCI_DEVICE_SUPPORT_H
  26
  27 EFI_STATUS
  28 InitializePciDevicePool (
  29   VOID
  30   )
  31 /*++
  32
  33 Routine Description:
  34
  35   TODO: Add function description
  36
  37 Arguments:
  38
  39   None
  40
  41 Returns:
  42
  43   TODO: add return values
  44
  45 --*/
  46 ;
  47
  48 EFI_STATUS
  49 InsertRootBridge (
  50   PCI_IO_DEVICE *RootBridge
  51   )
  52 /*++
  53
  54 Routine Description:
  55
  56   TODO: Add function description
  57
  58 Arguments:
  59
  60   RootBridge  - TODO: add argument description
  61
  62 Returns:
  63
  64   TODO: add return values
  65
  66 --*/
  67 ;
  68
  69 EFI_STATUS
  70 InsertPciDevice (
  71   PCI_IO_DEVICE *Bridge,
  72   PCI_IO_DEVICE *PciDeviceNode
  73   )
  74 /*++
  75
  76 Routine Description:
  77
  78   TODO: Add function description
  79
  80 Arguments:
  81
  82   Bridge        - TODO: add argument description
  83   PciDeviceNode - TODO: add argument description
  84
  85 Returns:
  86
  87   TODO: add return values
  88
  89 --*/
  90 ;
  91
  92 EFI_STATUS
  93 DestroyRootBridge (
  94   IN PCI_IO_DEVICE *RootBridge
  95   )
  96 /*++
  97
  98 Routine Description:
  99
 100   TODO: Add function description
 101
 102 Arguments:
 103
 104   RootBridge  - TODO: add argument description
 105
 106 Returns:
 107
 108   TODO: add return values
 109
 110 --*/
 111 ;
 112
 113 EFI_STATUS
 114 DestroyPciDeviceTree (
 115   IN PCI_IO_DEVICE *Bridge
 116   )
 117 /*++
 118
 119 Routine Description:
 120
 121   TODO: Add function description
 122
 123 Arguments:
 124
 125   Bridge  - TODO: add argument description
 126
 127 Returns:
 128
 129   TODO: add return values
 130
 131 --*/
 132 ;
 133
 134 EFI_STATUS
 135 DestroyRootBridgeByHandle (
 136   EFI_HANDLE Controller
 137   )
 138 /*++
 139
 140 Routine Description:
 141
 142   TODO: Add function description
 143
 144 Arguments:
 145
 146   Controller  - TODO: add argument description
 147
 148 Returns:
 149
 150   TODO: add return values
 151
 152 --*/
 153 ;
 154
 155 EFI_STATUS
 156 RegisterPciDevice (
 157   IN  EFI_HANDLE                     Controller,
 158   IN  PCI_IO_DEVICE                  *PciIoDevice,
 159   OUT EFI_HANDLE                     *Handle OPTIONAL
 160   )
 161 /*++
 162
 163 Routine Description:
 164
 165   TODO: Add function description
 166
 167 Arguments:
 168
 169   Controller  - TODO: add argument description
 170   PciIoDevice - TODO: add argument description
 171   Handle      - TODO: add argument description
 172
 173 Returns:
 174
 175   TODO: add return values
 176
 177 --*/
 178 ;
 179
 180 EFI_STATUS
 181 RemoveAllPciDeviceOnBridge (
 182   EFI_HANDLE               RootBridgeHandle,
 183   PCI_IO_DEVICE            *Bridge
 184   )
 185 /*++
 186
 187 Routine Description:
 188
 189   TODO: Add function description
 190
 191 Arguments:
 192
 193   RootBridgeHandle  - TODO: add argument description
 194   Bridge            - TODO: add argument description
 195
 196 Returns:
 197
 198   TODO: add return values
 199
 200 --*/
 201 ;
 202
 203 EFI_STATUS
 204 DeRegisterPciDevice (
 205   IN  EFI_HANDLE                     Controller,
 206   IN  EFI_HANDLE                     Handle
 207   )
 208 /*++
 209
 210 Routine Description:
 211
 212   TODO: Add function description
 213
 214 Arguments:
 215
 216   Controller  - TODO: add argument description
 217   Handle      - TODO: add argument description
 218
 219 Returns:
 220
 221   TODO: add return values
 222
 223 --*/
 224 ;
 225
 226 EFI_STATUS
 227 StartPciDevicesOnBridge (
 228   IN EFI_HANDLE                          Controller,
 229   IN PCI_IO_DEVICE                       *RootBridge,
 230   IN EFI_DEVICE_PATH_PROTOCOL            *RemainingDevicePath,
 231   IN OUT UINT8                           *NumberOfChildren,
 232   IN OUT EFI_HANDLE                      *ChildHandleBuffer
 233   )
 234 /*++
 235
 236 Routine Description:
 237
 238   TODO: Add function description
 239
 240 Arguments:
 241
 242   Controller          - TODO: add argument description
 243   RootBridge          - TODO: add argument description
 244   RemainingDevicePath - TODO: add argument description
 245   NumberOfChildren    - TODO: add argument description
 246   ChildHandleBuffer   - TODO: add argument description
 247
 248 Returns:
 249
 250   TODO: add return values
 251
 252 --*/
 253 ;
 254
 255 EFI_STATUS
 256 StartPciDevices (
 257   IN EFI_HANDLE                         Controller,
 258   IN EFI_DEVICE_PATH_PROTOCOL           *RemainingDevicePath
 259   )
 260 /*++
 261
 262 Routine Description:
 263
 264   TODO: Add function description
 265
 266 Arguments:
 267
 268   Controller          - TODO: add argument description
 269   RemainingDevicePath - TODO: add argument description
 270
 271 Returns:
 272
 273   TODO: add return values
 274
 275 --*/
 276 ;
 277
 278 PCI_IO_DEVICE *
 279 CreateRootBridge (
 280   IN EFI_HANDLE RootBridgeHandle
 281   )
 282 /*++
 283
 284 Routine Description:
 285
 286   TODO: Add function description
 287
 288 Arguments:
 289
 290   RootBridgeHandle  - TODO: add argument description
 291
 292 Returns:
 293
 294   TODO: add return values
 295
 296 --*/
 297 ;
 298
 299 PCI_IO_DEVICE *
 300 GetRootBridgeByHandle (
 301   EFI_HANDLE RootBridgeHandle
 302   )
 303 /*++
 304
 305 Routine Description:
 306
 307   TODO: Add function description
 308
 309 Arguments:
 310
 311   RootBridgeHandle  - TODO: add argument description
 312
 313 Returns:
 314
 315   TODO: add return values
 316
 317 --*/
 318 ;
 319
 320 BOOLEAN
 321 RootBridgeExisted (
 322   IN EFI_HANDLE RootBridgeHandle
 323   )
 324 /*++
 325
 326 Routine Description:
 327
 328   TODO: Add function description
 329
 330 Arguments:
 331
 332   RootBridgeHandle  - TODO: add argument description
 333
 334 Returns:
 335
 336   TODO: add return values
 337
 338 --*/
 339 ;
 340
 341 BOOLEAN
 342 PciDeviceExisted (
 343   IN PCI_IO_DEVICE    *Bridge,
 344   IN PCI_IO_DEVICE    *PciIoDevice
 345   )
 346 /*++
 347
 348 Routine Description:
 349
 350   TODO: Add function description
 351
 352 Arguments:
 353
 354   Bridge      - TODO: add argument description
 355   PciIoDevice - TODO: add argument description
 356
 357 Returns:
 358
 359   TODO: add return values
 360
 361 --*/
 362 ;
 363
 364 PCI_IO_DEVICE *
 365 ActiveVGADeviceOnTheSameSegment (
 366   IN PCI_IO_DEVICE        *VgaDevice
 367   )
 368 /*++
 369
 370 Routine Description:
 371
 372   TODO: Add function description
 373
 374 Arguments:
 375
 376   VgaDevice - TODO: add argument description
 377
 378 Returns:
 379
 380   TODO: add return values
 381
 382 --*/
 383 ;
 384
 385 PCI_IO_DEVICE *
 386 ActiveVGADeviceOnTheRootBridge (
 387   IN PCI_IO_DEVICE        *RootBridge
 388   )
 389 /*++
 390
 391 Routine Description:
 392
 393   TODO: Add function description
 394
 395 Arguments:
 396
 397   RootBridge  - TODO: add argument description
 398
 399 Returns:
 400
 401   TODO: add return values
 402
 403 --*/
 404 ;
 405
 406 EFI_STATUS
 407 GetHpcPciAddress (
 408   IN  EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL  *PciRootBridgeIo,
 409   IN  EFI_DEVICE_PATH_PROTOCOL         *HpcDevicePath,
 410   OUT UINT64                           *PciAddress
 411   )
 412 /*++
 413
 414 Routine Description:
 415
 416   TODO: Add function description
 417
 418 Arguments:
 419
 420   PciRootBridgeIo - TODO: add argument description
 421   HpcDevicePath   - TODO: add argument description
 422   PciAddress      - TODO: add argument description
 423
 424 Returns:
 425
 426   TODO: add return values
 427
 428 --*/
 429 ;
 430
 431 EFI_STATUS
 432 GetHpcPciAddressFromRootBridge (
 433   IN  PCI_IO_DEVICE                    *RootBridge,
 434   IN  EFI_DEVICE_PATH_PROTOCOL         *RemainingDevicePath,
 435   OUT UINT64                           *PciAddress
 436   )
 437 /*++
 438
 439 Routine Description:
 440
 441   TODO: Add function description
 442
 443 Arguments:
 444
 445   RootBridge          - TODO: add argument description
 446   RemainingDevicePath - TODO: add argument description
 447   PciAddress          - TODO: add argument description
 448
 449 Returns:
 450
 451   TODO: add return values
 452
 453 --*/
 454 ;
 455
 456 EFI_STATUS
 457 FreePciDevice (
 458   IN PCI_IO_DEVICE *PciIoDevice
 459   )
 460 /*++
 461
 462 Routine Description:
 463
 464   TODO: Add function description
 465
 466 Arguments:
 467
 468   PciIoDevice - TODO: add argument description
 469
 470 Returns:
 471
 472   TODO: add return values
 473
 474 --*/
 475 ;
 476
 477 #endif