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