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