IntelFrameworkModulePkg/Bus/Pci/PciBus/Dxe/PciEnumeratorSupport.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   PciEnumeratorSupport.h
  15
  16 Abstract:
  17
  18   PCI Bus Driver
  19
  20 Revision History
  21
  22 --*/
  23
  24 #ifndef _EFI_PCI_ENUMERATOR_SUPPORT_H
  25 #define _EFI_PCI_ENUMERATOR_SUPPORT_H
  26
  27 EFI_STATUS
  28 PciDevicePresent (
  29   IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL  *PciRootBridgeIo,
  30   PCI_TYPE00                          *Pci,
  31   UINT8                               Bus,
  32   UINT8                               Device,
  33   UINT8                               Func
  34   )
  35 /*++
  36
  37 Routine Description:
  38
  39   TODO: Add function description
  40
  41 Arguments:
  42
  43   PciRootBridgeIo - TODO: add argument description
  44   Pci             - TODO: add argument description
  45   Bus             - TODO: add argument description
  46   Device          - TODO: add argument description
  47   Func            - TODO: add argument description
  48
  49 Returns:
  50
  51   TODO: add return values
  52
  53 --*/
  54 ;
  55
  56 EFI_STATUS
  57 PciPciDeviceInfoCollector (
  58   IN PCI_IO_DEVICE                      *Bridge,
  59   UINT8                                 StartBusNumber
  60   )
  61 /*++
  62
  63 Routine Description:
  64
  65   TODO: Add function description
  66
  67 Arguments:
  68
  69   Bridge          - TODO: add argument description
  70   StartBusNumber  - TODO: add argument description
  71
  72 Returns:
  73
  74   TODO: add return values
  75
  76 --*/
  77 ;
  78
  79 EFI_STATUS
  80 PciSearchDevice (
  81   IN PCI_IO_DEVICE                      *Bridge,
  82   PCI_TYPE00                            *Pci,
  83   UINT8                                 Bus,
  84   UINT8                                 Device,
  85   UINT8                                 Func,
  86   PCI_IO_DEVICE                         **PciDevice
  87   )
  88 /*++
  89
  90 Routine Description:
  91
  92   TODO: Add function description
  93
  94 Arguments:
  95
  96   Bridge    - TODO: add argument description
  97   Pci       - TODO: add argument description
  98   Bus       - TODO: add argument description
  99   Device    - TODO: add argument description
 100   Func      - TODO: add argument description
 101   PciDevice - TODO: add argument description
 102
 103 Returns:
 104
 105   TODO: add return values
 106
 107 --*/
 108 ;
 109
 110 PCI_IO_DEVICE             *
 111 GatherDeviceInfo (
 112   IN PCI_IO_DEVICE                    *Bridge,
 113   IN PCI_TYPE00                       *Pci,
 114   UINT8                               Bus,
 115   UINT8                               Device,
 116   UINT8                               Func
 117   )
 118 /*++
 119
 120 Routine Description:
 121
 122   TODO: Add function description
 123
 124 Arguments:
 125
 126   Bridge  - TODO: add argument description
 127   Pci     - TODO: add argument description
 128   Bus     - TODO: add argument description
 129   Device  - TODO: add argument description
 130   Func    - TODO: add argument description
 131
 132 Returns:
 133
 134   TODO: add return values
 135
 136 --*/
 137 ;
 138
 139 PCI_IO_DEVICE             *
 140 GatherPpbInfo (
 141   IN PCI_IO_DEVICE                    *Bridge,
 142   IN PCI_TYPE00                       *Pci,
 143   UINT8                               Bus,
 144   UINT8                               Device,
 145   UINT8                               Func
 146   )
 147 /*++
 148
 149 Routine Description:
 150
 151   TODO: Add function description
 152
 153 Arguments:
 154
 155   Bridge  - TODO: add argument description
 156   Pci     - TODO: add argument description
 157   Bus     - TODO: add argument description
 158   Device  - TODO: add argument description
 159   Func    - TODO: add argument description
 160
 161 Returns:
 162
 163   TODO: add return values
 164
 165 --*/
 166 ;
 167
 168 PCI_IO_DEVICE             *
 169 GatherP2CInfo (
 170   IN PCI_IO_DEVICE                    *Bridge,
 171   IN PCI_TYPE00                       *Pci,
 172   UINT8                               Bus,
 173   UINT8                               Device,
 174   UINT8                               Func
 175   )
 176 /*++
 177
 178 Routine Description:
 179
 180   TODO: Add function description
 181
 182 Arguments:
 183
 184   Bridge  - TODO: add argument description
 185   Pci     - TODO: add argument description
 186   Bus     - TODO: add argument description
 187   Device  - TODO: add argument description
 188   Func    - TODO: add argument description
 189
 190 Returns:
 191
 192   TODO: add return values
 193
 194 --*/
 195 ;
 196
 197 EFI_DEVICE_PATH_PROTOCOL  *
 198 CreatePciDevicePath (
 199   IN  EFI_DEVICE_PATH_PROTOCOL *ParentDevicePath,
 200   IN  PCI_IO_DEVICE            *PciIoDevice
 201   )
 202 /*++
 203
 204 Routine Description:
 205
 206   TODO: Add function description
 207
 208 Arguments:
 209
 210   ParentDevicePath  - TODO: add argument description
 211   PciIoDevice       - TODO: add argument description
 212
 213 Returns:
 214
 215   TODO: add return values
 216
 217 --*/
 218 ;
 219
 220 EFI_STATUS
 221 BarExisted (
 222   IN PCI_IO_DEVICE *PciIoDevice,
 223   IN UINTN         Offset,
 224   OUT UINT32       *BarLengthValue,
 225   OUT UINT32       *OriginalBarValue
 226   )
 227 /*++
 228
 229 Routine Description:
 230
 231   TODO: Add function description
 232
 233 Arguments:
 234
 235   PciIoDevice       - TODO: add argument description
 236   Offset            - TODO: add argument description
 237   BarLengthValue    - TODO: add argument description
 238   OriginalBarValue  - TODO: add argument description
 239
 240 Returns:
 241
 242   TODO: add return values
 243
 244 --*/
 245 ;
 246
 247 EFI_STATUS
 248 PciTestSupportedAttribute (
 249   IN PCI_IO_DEVICE                      *PciIoDevice,
 250   IN UINT16                             *Command,
 251   IN UINT16                             *BridgeControl,
 252   IN UINT16                             *OldCommand,
 253   IN UINT16                             *OldBridgeControl
 254   )
 255 /*++
 256
 257 Routine Description:
 258
 259   TODO: Add function description
 260
 261 Arguments:
 262
 263   PciIoDevice       - TODO: add argument description
 264   Command           - TODO: add argument description
 265   BridgeControl     - TODO: add argument description
 266   OldCommand        - TODO: add argument description
 267   OldBridgeControl  - TODO: add argument description
 268
 269 Returns:
 270
 271   TODO: add return values
 272
 273 --*/
 274 ;
 275
 276 EFI_STATUS
 277 PciSetDeviceAttribute (
 278   IN PCI_IO_DEVICE                      *PciIoDevice,
 279   IN UINT16                             Command,
 280   IN UINT16                             BridgeControl,
 281   IN UINTN                              Option
 282   )
 283 /*++
 284
 285 Routine Description:
 286
 287   TODO: Add function description
 288
 289 Arguments:
 290
 291   PciIoDevice   - TODO: add argument description
 292   Command       - TODO: add argument description
 293   BridgeControl - TODO: add argument description
 294   Option        - TODO: add argument description
 295
 296 Returns:
 297
 298   TODO: add return values
 299
 300 --*/
 301 ;
 302
 303 EFI_STATUS
 304 GetFastBackToBackSupport (
 305   IN PCI_IO_DEVICE                      *PciIoDevice,
 306   IN UINT8                              StatusIndex
 307   )
 308 /*++
 309
 310 Routine Description:
 311
 312   TODO: Add function description
 313
 314 Arguments:
 315
 316   PciIoDevice - TODO: add argument description
 317   StatusIndex - TODO: add argument description
 318
 319 Returns:
 320
 321   TODO: add return values
 322
 323 --*/
 324 ;
 325
 326 EFI_STATUS
 327 DetermineDeviceAttribute (
 328   IN PCI_IO_DEVICE                      *PciIoDevice
 329   )
 330 /*++
 331
 332 Routine Description:
 333
 334   TODO: Add function description
 335
 336 Arguments:
 337
 338   PciIoDevice - TODO: add argument description
 339
 340 Returns:
 341
 342   TODO: add return values
 343
 344 --*/
 345 ;
 346
 347 EFI_STATUS
 348 UpdatePciInfo (
 349   IN PCI_IO_DEVICE  *PciIoDevice
 350   )
 351 /*++
 352
 353 Routine Description:
 354
 355   TODO: Add function description
 356
 357 Arguments:
 358
 359   PciIoDevice - TODO: add argument description
 360
 361 Returns:
 362
 363   TODO: add return values
 364
 365 --*/
 366 ;
 367
 368 VOID
 369 SetNewAlign (
 370   IN UINT64 *Alignment,
 371   IN UINT64 NewAlignment
 372   )
 373 /*++
 374
 375 Routine Description:
 376
 377   TODO: Add function description
 378
 379 Arguments:
 380
 381   Alignment     - TODO: add argument description
 382   NewAlignment  - TODO: add argument description
 383
 384 Returns:
 385
 386   TODO: add return values
 387
 388 --*/
 389 ;
 390
 391 UINTN
 392 PciParseBar (
 393   IN PCI_IO_DEVICE  *PciIoDevice,
 394   IN UINTN          Offset,
 395   IN UINTN          BarIndex
 396   )
 397 /*++
 398
 399 Routine Description:
 400
 401   TODO: Add function description
 402
 403 Arguments:
 404
 405   PciIoDevice - TODO: add argument description
 406   Offset      - TODO: add argument description
 407   BarIndex    - TODO: add argument description
 408
 409 Returns:
 410
 411   TODO: add return values
 412
 413 --*/
 414 ;
 415
 416 EFI_STATUS
 417 InitializePciDevice (
 418   IN PCI_IO_DEVICE *PciIoDevice
 419   )
 420 /*++
 421
 422 Routine Description:
 423
 424   TODO: Add function description
 425
 426 Arguments:
 427
 428   PciIoDevice - TODO: add argument description
 429
 430 Returns:
 431
 432   TODO: add return values
 433
 434 --*/
 435 ;
 436
 437 EFI_STATUS
 438 InitializePpb (
 439   IN PCI_IO_DEVICE *PciIoDevice
 440   )
 441 /*++
 442
 443 Routine Description:
 444
 445   TODO: Add function description
 446
 447 Arguments:
 448
 449   PciIoDevice - TODO: add argument description
 450
 451 Returns:
 452
 453   TODO: add return values
 454
 455 --*/
 456 ;
 457
 458 EFI_STATUS
 459 InitializeP2C (
 460   IN PCI_IO_DEVICE *PciIoDevice
 461   )
 462 /*++
 463
 464 Routine Description:
 465
 466   TODO: Add function description
 467
 468 Arguments:
 469
 470   PciIoDevice - TODO: add argument description
 471
 472 Returns:
 473
 474   TODO: add return values
 475
 476 --*/
 477 ;
 478
 479 PCI_IO_DEVICE             *
 480 CreatePciIoDevice (
 481   IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL  *PciRootBridgeIo,
 482   IN PCI_TYPE00                       *Pci,
 483   UINT8                               Bus,
 484   UINT8                               Device,
 485   UINT8                               Func
 486   )
 487 /*++
 488
 489 Routine Description:
 490
 491   TODO: Add function description
 492
 493 Arguments:
 494
 495   PciRootBridgeIo - TODO: add argument description
 496   Pci             - TODO: add argument description
 497   Bus             - TODO: add argument description
 498   Device          - TODO: add argument description
 499   Func            - TODO: add argument description
 500
 501 Returns:
 502
 503   TODO: add return values
 504
 505 --*/
 506 ;
 507
 508 EFI_STATUS
 509 PciEnumeratorLight (
 510   IN EFI_HANDLE                    Controller
 511   )
 512 /*++
 513
 514 Routine Description:
 515
 516   TODO: Add function description
 517
 518 Arguments:
 519
 520   Controller  - TODO: add argument description
 521
 522 Returns:
 523
 524   TODO: add return values
 525
 526 --*/
 527 ;
 528
 529 EFI_STATUS
 530 PciGetBusRange (
 531   IN     EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR  **Descriptors,
 532   OUT    UINT16                             *MinBus,
 533   OUT    UINT16                             *MaxBus,
 534   OUT    UINT16                             *BusRange
 535   )
 536 /*++
 537
 538 Routine Description:
 539
 540   TODO: Add function description
 541
 542 Arguments:
 543
 544   Descriptors - TODO: add argument description
 545   MinBus      - TODO: add argument description
 546   MaxBus      - TODO: add argument description
 547   BusRange    - TODO: add argument description
 548
 549 Returns:
 550
 551   TODO: add return values
 552
 553 --*/
 554 ;
 555
 556 EFI_STATUS
 557 StartManagingRootBridge (
 558   IN PCI_IO_DEVICE *RootBridgeDev
 559   )
 560 /*++
 561
 562 Routine Description:
 563
 564   TODO: Add function description
 565
 566 Arguments:
 567
 568   RootBridgeDev - TODO: add argument description
 569
 570 Returns:
 571
 572   TODO: add return values
 573
 574 --*/
 575 ;
 576
 577 BOOLEAN
 578 IsPciDeviceRejected (
 579   IN PCI_IO_DEVICE *PciIoDevice
 580   )
 581 /*++
 582
 583 Routine Description:
 584
 585   TODO: Add function description
 586
 587 Arguments:
 588
 589   PciIoDevice - TODO: add argument description
 590
 591 Returns:
 592
 593   TODO: add return values
 594
 595 --*/
 596 ;
 597
 598 #endif