MdeModulePkg/Bus/Pci/PciBusDxe/PciResourceSupport.h

   1 /** @file
   2   PCI resouces support functions declaration for PCI Bus module.
   3
   4 Copyright (c) 2006 - 2009, Intel Corporation
   5 All rights reserved. This program and the accompanying materials
   6 are licensed and made available under the terms and conditions of the BSD License
   7 which accompanies this distribution.  The full text of the license may be found at
   8 http://opensource.org/licenses/bsd-license.php
   9
  10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef _EFI_PCI_RESOURCE_SUPPORT_H_
  16 #define _EFI_PCI_RESOURCE_SUPPORT_H_
  17
  18 typedef enum {
  19   PciResUsageTypical            = 0,
  20   PciResUsagePadding,
  21   PciResUsageOptionRomProcessing
  22 } PCI_RESOURCE_USAGE;
  23
  24 #define PCI_RESOURCE_SIGNATURE  SIGNATURE_32 ('p', 'c', 'r', 'c')
  25
  26 typedef struct {
  27   UINT32              Signature;
  28   LIST_ENTRY          Link;
  29   LIST_ENTRY          ChildList;
  30   PCI_IO_DEVICE       *PciDev;
  31   UINT64              Alignment;
  32   UINT64              Offset;
  33   UINT8               Bar;
  34   PCI_BAR_TYPE        ResType;
  35   UINT64              Length;
  36   BOOLEAN             Reserved;
  37   PCI_RESOURCE_USAGE  ResourceUsage;
  38   BOOLEAN             Virtual;
  39 } PCI_RESOURCE_NODE;
  40
  41 #define RESOURCE_NODE_FROM_LINK(a) \
  42   CR (a, PCI_RESOURCE_NODE, Link, PCI_RESOURCE_SIGNATURE)
  43
  44 /**
  45   The function is used to skip VGA range.
  46
  47   @param Start    Returned start address including VGA range.
  48   @param Length   The length of VGA range.
  49
  50 **/
  51 VOID
  52 SkipVGAAperture (
  53   OUT UINT64   *Start,
  54   IN  UINT64   Length
  55   );
  56
  57 /**
  58   This function is used to skip ISA aliasing aperture.
  59
  60   @param Start    Returned start address including ISA aliasing aperture.
  61   @param Length   The length of ISA aliasing aperture.
  62
  63 **/
  64 VOID
  65 SkipIsaAliasAperture (
  66   OUT UINT64   *Start,
  67   IN  UINT64   Length
  68   );
  69
  70 /**
  71   This function inserts a resource node into the resource list.
  72   The resource list is sorted in descend order.
  73
  74   @param Bridge  PCI resource node for bridge.
  75   @param ResNode Resource node want to be inserted.
  76
  77 **/
  78 VOID
  79 InsertResourceNode (
  80   IN OUT PCI_RESOURCE_NODE   *Bridge,
  81   IN     PCI_RESOURCE_NODE   *ResNode
  82   );
  83
  84 /**
  85   This routine is used to merge two different resource trees in need of
  86   resoure degradation.
  87
  88   For example, if an upstream PPB doesn't support,
  89   prefetchable memory decoding, the PCI bus driver will choose to call this function
  90   to merge prefectchable memory resource list into normal memory list.
  91
  92   If the TypeMerge is TRUE, Res resource type is changed to the type of destination resource
  93   type.
  94   If Dst is NULL or Res is NULL, ASSERT ().
  95
  96   @param Dst        Point to destination resource tree.
  97   @param Res        Point to source resource tree.
  98   @param TypeMerge  If the TypeMerge is TRUE, Res resource type is changed to the type of
  99                     destination resource type.
 100
 101 **/
 102 VOID
 103 MergeResourceTree (
 104   IN PCI_RESOURCE_NODE   *Dst,
 105   IN PCI_RESOURCE_NODE   *Res,
 106   IN BOOLEAN             TypeMerge
 107   );
 108
 109 /**
 110   This function is used to calculate the IO16 aperture
 111   for a bridge.
 112
 113   @param Bridge    PCI resource node for bridge.
 114
 115 **/
 116 VOID
 117 CalculateApertureIo16 (
 118   IN PCI_RESOURCE_NODE    *Bridge
 119   );
 120
 121 /**
 122   This function is used to calculate the resource aperture
 123   for a given bridge device.
 124
 125   @param Bridge      PCI resouce node for given bridge device.
 126
 127 **/
 128 VOID
 129 CalculateResourceAperture (
 130   IN PCI_RESOURCE_NODE    *Bridge
 131   );
 132
 133 /**
 134   Get IO/Memory resource infor for given PCI device.
 135
 136   @param PciDev     Pci device instance.
 137   @param IoNode     Resource info node for IO .
 138   @param Mem32Node  Resource info node for 32-bit memory.
 139   @param PMem32Node Resource info node for 32-bit Prefetchable Memory.
 140   @param Mem64Node  Resource info node for 64-bit memory.
 141   @param PMem64Node Resource info node for 64-bit Prefetchable Memory.
 142
 143 **/
 144 VOID
 145 GetResourceFromDevice (
 146   IN     PCI_IO_DEVICE     *PciDev,
 147   IN OUT PCI_RESOURCE_NODE *IoNode,
 148   IN OUT PCI_RESOURCE_NODE *Mem32Node,
 149   IN OUT PCI_RESOURCE_NODE *PMem32Node,
 150   IN OUT PCI_RESOURCE_NODE *Mem64Node,
 151   IN OUT PCI_RESOURCE_NODE *PMem64Node
 152   );
 153
 154 /**
 155   This function is used to create a resource node.
 156
 157   @param PciDev       Pci device instance.
 158   @param Length       Length of Io/Memory resource.
 159   @param Alignment    Alignment of resource.
 160   @param Bar          Bar index.
 161   @param ResType      Type of resource: IO/Memory.
 162   @param ResUsage     Resource usage.
 163
 164   @return PCI resource node created for given PCI device.
 165           NULL means PCI resource node is not created.
 166
 167 **/
 168 PCI_RESOURCE_NODE *
 169 CreateResourceNode (
 170   IN PCI_IO_DEVICE         *PciDev,
 171   IN UINT64                Length,
 172   IN UINT64                Alignment,
 173   IN UINT8                 Bar,
 174   IN PCI_BAR_TYPE          ResType,
 175   IN PCI_RESOURCE_USAGE    ResUsage
 176   );
 177
 178 /**
 179   This function is used to extract resource request from
 180   IOV VF device node list.
 181
 182   @param Bridge     Pci device instance.
 183   @param IoNode     Resource info node for IO.
 184   @param Mem32Node  Resource info node for 32-bit memory.
 185   @param PMem32Node Resource info node for 32-bit Prefetchable Memory.
 186   @param Mem64Node  Resource info node for 64-bit memory.
 187   @param PMem64Node Resource info node for 64-bit Prefetchable Memory.
 188
 189 **/
 190 PCI_RESOURCE_NODE *
 191 CreateVfResourceNode (
 192   IN PCI_IO_DEVICE         *PciDev,
 193   IN UINT64                Length,
 194   IN UINT64                Alignment,
 195   IN UINT8                 Bar,
 196   IN PCI_BAR_TYPE          ResType,
 197   IN PCI_RESOURCE_USAGE    ResUsage
 198   );
 199
 200 /**
 201   This function is used to extract resource request from
 202   device node list.
 203
 204   @param Bridge     Pci device instance.
 205   @param IoNode     Resource info node for IO.
 206   @param Mem32Node  Resource info node for 32-bit memory.
 207   @param PMem32Node Resource info node for 32-bit Prefetchable Memory.
 208   @param Mem64Node  Resource info node for 64-bit memory.
 209   @param PMem64Node Resource info node for 64-bit Prefetchable Memory.
 210
 211 **/
 212 VOID
 213 CreateResourceMap (
 214   IN     PCI_IO_DEVICE     *Bridge,
 215   IN OUT PCI_RESOURCE_NODE *IoNode,
 216   IN OUT PCI_RESOURCE_NODE *Mem32Node,
 217   IN OUT PCI_RESOURCE_NODE *PMem32Node,
 218   IN OUT PCI_RESOURCE_NODE *Mem64Node,
 219   IN OUT PCI_RESOURCE_NODE *PMem64Node
 220   );
 221
 222 /**
 223   This function is used to do the resource padding for a specific platform.
 224
 225   @param PciDev     Pci device instance.
 226   @param IoNode     Resource info node for IO.
 227   @param Mem32Node  Resource info node for 32-bit memory.
 228   @param PMem32Node Resource info node for 32-bit Prefetchable Memory.
 229   @param Mem64Node  Resource info node for 64-bit memory.
 230   @param PMem64Node Resource info node for 64-bit Prefetchable Memory.
 231
 232 **/
 233 VOID
 234 ResourcePaddingPolicy (
 235   IN PCI_IO_DEVICE     *PciDev,
 236   IN PCI_RESOURCE_NODE *IoNode,
 237   IN PCI_RESOURCE_NODE *Mem32Node,
 238   IN PCI_RESOURCE_NODE *PMem32Node,
 239   IN PCI_RESOURCE_NODE *Mem64Node,
 240   IN PCI_RESOURCE_NODE *PMem64Node
 241   );
 242
 243 /**
 244   This function is used to degrade resource if the upstream bridge
 245   doesn't support certain resource. Degradation path is
 246   PMEM64 -> MEM64  -> MEM32
 247   PMEM64 -> PMEM32 -> MEM32
 248   IO32   -> IO16.
 249
 250   @param Bridge     Pci device instance.
 251   @param Mem32Node  Resource info node for 32-bit memory.
 252   @param PMem32Node Resource info node for 32-bit Prefetchable Memory.
 253   @param Mem64Node  Resource info node for 64-bit memory.
 254   @param PMem64Node Resource info node for 64-bit Prefetchable Memory.
 255
 256 **/
 257 VOID
 258 DegradeResource (
 259   IN PCI_IO_DEVICE     *Bridge,
 260   IN PCI_RESOURCE_NODE *Mem32Node,
 261   IN PCI_RESOURCE_NODE *PMem32Node,
 262   IN PCI_RESOURCE_NODE *Mem64Node,
 263   IN PCI_RESOURCE_NODE *PMem64Node
 264   );
 265
 266 /**
 267   Test whether bridge device support decode resource.
 268
 269   @param Bridge    Bridge device instance.
 270   @param Decode    Decode type according to resource type.
 271
 272   @return TRUE     The bridge device support decode resource.
 273   @return FALSE    The bridge device don't support decode resource.
 274
 275 **/
 276 BOOLEAN
 277 BridgeSupportResourceDecode (
 278   IN PCI_IO_DEVICE *Bridge,
 279   IN UINT32        Decode
 280   );
 281
 282 /**
 283   This function is used to program the resource allocated
 284   for each resource node under specified bridge.
 285
 286   @param Base     Base address of resource to be progammed.
 287   @param Bridge   PCI resource node for the bridge device.
 288
 289   @retval EFI_SUCCESS            Successfully to program all resouces
 290                                  on given PCI bridge device.
 291   @retval EFI_OUT_OF_RESOURCES   Base is all one.
 292
 293 **/
 294 EFI_STATUS
 295 ProgramResource (
 296   IN UINT64            Base,
 297   IN PCI_RESOURCE_NODE *Bridge
 298   );
 299
 300 /**
 301   Program Bar register for PCI device.
 302
 303   @param Base  Base address for PCI device resource to be progammed.
 304   @param Node  Point to resoure node structure.
 305
 306 **/
 307 VOID
 308 ProgramBar (
 309   IN UINT64            Base,
 310   IN PCI_RESOURCE_NODE *Node
 311   );
 312
 313 /**
 314   Program IOV VF Bar register for PCI device.
 315
 316   @param Base  Base address for PCI device resource to be progammed.
 317   @param Node  Point to resoure node structure.
 318
 319 **/
 320 EFI_STATUS
 321 ProgramVfBar (
 322   IN UINT64            Base,
 323   IN PCI_RESOURCE_NODE *Node
 324   );
 325
 326 /**
 327   Program PCI-PCI bridge apperture.
 328
 329   @param Base  Base address for resource.
 330   @param Node  Point to resoure node structure.
 331
 332 **/
 333 VOID
 334 ProgramPpbApperture (
 335   IN UINT64            Base,
 336   IN PCI_RESOURCE_NODE *Node
 337   );
 338
 339 /**
 340   Program parent bridge for Option Rom.
 341
 342   @param PciDevice      Pci deivce instance.
 343   @param OptionRomBase  Base address for Optiona Rom.
 344   @param Enable         Enable or disable PCI memory.
 345
 346 **/
 347 VOID
 348 ProgrameUpstreamBridgeForRom (
 349   IN PCI_IO_DEVICE   *PciDevice,
 350   IN UINT32          OptionRomBase,
 351   IN BOOLEAN         Enable
 352   );
 353
 354 /**
 355   Test whether resource exists for a bridge.
 356
 357   @param Bridge  Point to resource node for a bridge.
 358
 359   @retval TRUE   There is resource on the given bridge.
 360   @retval FALSE  There isn't resource on the given bridge.
 361
 362 **/
 363 BOOLEAN
 364 ResourceRequestExisted (
 365   IN PCI_RESOURCE_NODE    *Bridge
 366   );
 367
 368 /**
 369   Initialize resource pool structure.
 370
 371   @param ResourcePool Point to resource pool structure. This pool
 372                       is reset to all zero when returned.
 373   @param ResourceType Type of resource.
 374
 375 **/
 376 VOID
 377 InitializeResourcePool (
 378   IN OUT PCI_RESOURCE_NODE   *ResourcePool,
 379   IN     PCI_BAR_TYPE        ResourceType
 380   );
 381
 382 /**
 383   Get all resource information for given Pci device.
 384
 385   @param PciDev         Pci device instance.
 386   @param IoBridge       Io resource node.
 387   @param Mem32Bridge    32-bit memory node.
 388   @param PMem32Bridge   32-bit Pmemory node.
 389   @param Mem64Bridge    64-bit memory node.
 390   @param PMem64Bridge   64-bit PMemory node.
 391   @param IoPool         Link list header for Io resource.
 392   @param Mem32Pool      Link list header for 32-bit memory.
 393   @param PMem32Pool     Link list header for 32-bit Prefetchable memory.
 394   @param Mem64Pool      Link list header for 64-bit memory.
 395   @param PMem64Pool     Link list header for 64-bit Prefetchable memory.
 396
 397 **/
 398 VOID
 399 GetResourceMap (
 400   IN PCI_IO_DEVICE      *PciDev,
 401   IN PCI_RESOURCE_NODE  **IoBridge,
 402   IN PCI_RESOURCE_NODE  **Mem32Bridge,
 403   IN PCI_RESOURCE_NODE  **PMem32Bridge,
 404   IN PCI_RESOURCE_NODE  **Mem64Bridge,
 405   IN PCI_RESOURCE_NODE  **PMem64Bridge,
 406   IN PCI_RESOURCE_NODE  *IoPool,
 407   IN PCI_RESOURCE_NODE  *Mem32Pool,
 408   IN PCI_RESOURCE_NODE  *PMem32Pool,
 409   IN PCI_RESOURCE_NODE  *Mem64Pool,
 410   IN PCI_RESOURCE_NODE  *PMem64Pool
 411   );
 412
 413 /**
 414   Destory given resource tree.
 415
 416   @param Bridge  PCI resource root node of resource tree.
 417
 418 **/
 419 VOID
 420 DestroyResourceTree (
 421   IN PCI_RESOURCE_NODE *Bridge
 422   );
 423
 424 /**
 425   Insert resource padding for P2C.
 426
 427   @param PciDev     Pci device instance.
 428   @param IoNode     Resource info node for IO.
 429   @param Mem32Node  Resource info node for 32-bit memory.
 430   @param PMem32Node Resource info node for 32-bit Prefetchable Memory.
 431   @param Mem64Node  Resource info node for 64-bit memory.
 432   @param PMem64Node Resource info node for 64-bit Prefetchable Memory.
 433
 434 **/
 435 VOID
 436 ResourcePaddingForCardBusBridge (
 437   IN PCI_IO_DEVICE        *PciDev,
 438   IN PCI_RESOURCE_NODE    *IoNode,
 439   IN PCI_RESOURCE_NODE    *Mem32Node,
 440   IN PCI_RESOURCE_NODE    *PMem32Node,
 441   IN PCI_RESOURCE_NODE    *Mem64Node,
 442   IN PCI_RESOURCE_NODE    *PMem64Node
 443   );
 444
 445 /**
 446   Program PCI Card device register for given resource node.
 447
 448   @param Base    Base address of PCI Card device to be programmed.
 449   @param Node    Given resource node.
 450
 451 **/
 452 VOID
 453 ProgramP2C (
 454   IN UINT64            Base,
 455   IN PCI_RESOURCE_NODE *Node
 456   );
 457
 458 /**
 459   Create padding resource node.
 460
 461   @param PciDev     Pci device instance.
 462   @param IoNode     Resource info node for IO.
 463   @param Mem32Node  Resource info node for 32-bit memory.
 464   @param PMem32Node Resource info node for 32-bit Prefetchable Memory.
 465   @param Mem64Node  Resource info node for 64-bit memory.
 466   @param PMem64Node Resource info node for 64-bit Prefetchable Memory.
 467
 468 **/
 469 VOID
 470 ApplyResourcePadding (
 471   IN PCI_IO_DEVICE         *PciDev,
 472   IN PCI_RESOURCE_NODE     *IoNode,
 473   IN PCI_RESOURCE_NODE     *Mem32Node,
 474   IN PCI_RESOURCE_NODE     *PMem32Node,
 475   IN PCI_RESOURCE_NODE     *Mem64Node,
 476   IN PCI_RESOURCE_NODE     *PMem64Node
 477   );
 478
 479 /**
 480   Get padding resource for PCI-PCI bridge.
 481
 482   @param  PciIoDevice     PCI-PCI bridge device instance.
 483
 484   @note   Feature flag PcdPciBusHotplugDeviceSupport determines
 485           whether need to pad resource for them.
 486 **/
 487 VOID
 488 GetResourcePaddingPpb (
 489   IN  PCI_IO_DEVICE                  *PciIoDevice
 490   );
 491
 492 #endif