IntelFrameworkModulePkg/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 } PCI_RESOURCE_NODE;
  39
  40 #define RESOURCE_NODE_FROM_LINK(a) \
  41   CR (a, PCI_RESOURCE_NODE, Link, PCI_RESOURCE_SIGNATURE)
  42
  43 /**
  44   The function is used to skip VGA range.
  45
  46   @param Start    Returned start address including VGA range.
  47   @param Length   The length of VGA range.
  48
  49 **/
  50 VOID
  51 SkipVGAAperture (
  52   OUT UINT64   *Start,
  53   IN  UINT64   Length
  54   );
  55
  56 /**
  57   This function is used to skip ISA aliasing aperture.
  58
  59   @param Start    Returned start address including ISA aliasing aperture.
  60   @param Length   The length of ISA aliasing aperture.
  61
  62 **/
  63 VOID
  64 SkipIsaAliasAperture (
  65   OUT UINT64   *Start,
  66   IN  UINT64   Length
  67   );
  68
  69 /**
  70   This function inserts a resource node into the resource list.
  71   The resource list is sorted in descend order.
  72
  73   @param Bridge  PCI resource node for bridge.
  74   @param ResNode Resource node want to be inserted.
  75
  76 **/
  77 VOID
  78 InsertResourceNode (
  79   IN PCI_RESOURCE_NODE   *Bridge,
  80   IN PCI_RESOURCE_NODE   *ResNode
  81   );
  82
  83 /**
  84   This routine is used to merge two different resource trees in need of
  85   resoure degradation.
  86
  87   For example, if an upstream PPB doesn't support,
  88   prefetchable memory decoding, the PCI bus driver will choose to call this function
  89   to merge prefectchable memory resource list into normal memory list.
  90
  91   If the TypeMerge is TRUE, Res resource type is changed to the type of destination resource
  92   type.
  93   If Dst is NULL or Res is NULL, ASSERT ().
  94
  95   @param Dst        Point to destination resource tree.
  96   @param Res        Point to source resource tree.
  97   @param TypeMerge  If the TypeMerge is TRUE, Res resource type is changed to the type of
  98                     destination resource type.
  99
 100 **/
 101 VOID
 102 MergeResourceTree (
 103   IN PCI_RESOURCE_NODE   *Dst,
 104   IN PCI_RESOURCE_NODE   *Res,
 105   IN BOOLEAN             TypeMerge
 106   );
 107
 108 /**
 109   This function is used to calculate the IO16 aperture
 110   for a bridge.
 111
 112   @param Bridge    PCI resource node for bridge.
 113
 114 **/
 115 VOID
 116 CalculateApertureIo16 (
 117   IN PCI_RESOURCE_NODE    *Bridge
 118   );
 119
 120 /**
 121   This function is used to calculate the resource aperture
 122   for a given bridge device.
 123
 124   @param Bridge      PCI resouce node for given bridge device.
 125
 126 **/
 127 VOID
 128 CalculateResourceAperture (
 129   IN PCI_RESOURCE_NODE    *Bridge
 130   );
 131
 132 /**
 133   Get IO/Memory resource infor for given PCI device.
 134
 135   @param PciDev     Pci device instance.
 136   @param IoNode     Resource info node for IO .
 137   @param Mem32Node  Resource info node for 32-bit memory.
 138   @param PMem32Node Resource info node for 32-bit Prefetchable Memory.
 139   @param Mem64Node  Resource info node for 64-bit memory.
 140   @param PMem64Node Resource info node for 64-bit Prefetchable Memory.
 141
 142 **/
 143 VOID
 144 GetResourceFromDevice (
 145   IN PCI_IO_DEVICE     *PciDev,
 146   IN PCI_RESOURCE_NODE *IoNode,
 147   IN PCI_RESOURCE_NODE *Mem32Node,
 148   IN PCI_RESOURCE_NODE *PMem32Node,
 149   IN PCI_RESOURCE_NODE *Mem64Node,
 150   IN PCI_RESOURCE_NODE *PMem64Node
 151   );
 152
 153 /**
 154   This function is used to create a resource node.
 155
 156   @param PciDev       Pci device instance.
 157   @param Length       Length of Io/Memory resource.
 158   @param Alignment    Alignment of resource.
 159   @param Bar          Bar index.
 160   @param ResType      Type of resource: IO/Memory.
 161   @param ResUsage     Resource usage.
 162
 163   @return PCI resource node created for given PCI device.
 164           NULL means PCI resource node is not created.
 165
 166 **/
 167 PCI_RESOURCE_NODE *
 168 CreateResourceNode (
 169   IN PCI_IO_DEVICE         *PciDev,
 170   IN UINT64                Length,
 171   IN UINT64                Alignment,
 172   IN UINT8                 Bar,
 173   IN PCI_BAR_TYPE          ResType,
 174   IN PCI_RESOURCE_USAGE    ResUsage
 175   );
 176
 177 /**
 178   This function is used to extract resource request from
 179   device node list.
 180
 181   @param Bridge     Pci device instance.
 182   @param IoNode     Resource info node for IO.
 183   @param Mem32Node  Resource info node for 32-bit memory.
 184   @param PMem32Node Resource info node for 32-bit Prefetchable Memory.
 185   @param Mem64Node  Resource info node for 64-bit memory.
 186   @param PMem64Node Resource info node for 64-bit Prefetchable Memory.
 187
 188 **/
 189 VOID
 190 CreateResourceMap (
 191   IN PCI_IO_DEVICE     *Bridge,
 192   IN PCI_RESOURCE_NODE *IoNode,
 193   IN PCI_RESOURCE_NODE *Mem32Node,
 194   IN PCI_RESOURCE_NODE *PMem32Node,
 195   IN PCI_RESOURCE_NODE *Mem64Node,
 196   IN PCI_RESOURCE_NODE *PMem64Node
 197   );
 198
 199 /**
 200   This function is used to do the resource padding for a specific platform.
 201
 202   @param PciDev     Pci device instance.
 203   @param IoNode     Resource info node for IO.
 204   @param Mem32Node  Resource info node for 32-bit memory.
 205   @param PMem32Node Resource info node for 32-bit Prefetchable Memory.
 206   @param Mem64Node  Resource info node for 64-bit memory.
 207   @param PMem64Node Resource info node for 64-bit Prefetchable Memory.
 208
 209 **/
 210 VOID
 211 ResourcePaddingPolicy (
 212   IN PCI_IO_DEVICE     *PciDev,
 213   IN PCI_RESOURCE_NODE *IoNode,
 214   IN PCI_RESOURCE_NODE *Mem32Node,
 215   IN PCI_RESOURCE_NODE *PMem32Node,
 216   IN PCI_RESOURCE_NODE *Mem64Node,
 217   IN PCI_RESOURCE_NODE *PMem64Node
 218   );
 219
 220 /**
 221   This function is used to degrade resource if the upstream bridge
 222   doesn't support certain resource. Degradation path is
 223   PMEM64 -> MEM64  -> MEM32
 224   PMEM64 -> PMEM32 -> MEM32
 225   IO32   -> IO16.
 226
 227   @param Bridge     Pci device instance.
 228   @param Mem32Node  Resource info node for 32-bit memory.
 229   @param PMem32Node Resource info node for 32-bit Prefetchable Memory.
 230   @param Mem64Node  Resource info node for 64-bit memory.
 231   @param PMem64Node Resource info node for 64-bit Prefetchable Memory.
 232
 233 **/
 234 VOID
 235 DegradeResource (
 236   IN PCI_IO_DEVICE     *Bridge,
 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   Test whether bridge device support decode resource.
 245
 246   @param Bridge    Bridge device instance.
 247   @param Decode    Decode type according to resource type.
 248
 249   @return TRUE     The bridge device support decode resource.
 250   @return FALSE    The bridge device don't support decode resource.
 251
 252 **/
 253 BOOLEAN
 254 BridgeSupportResourceDecode (
 255   IN PCI_IO_DEVICE *Bridge,
 256   IN UINT32        Decode
 257   );
 258
 259 /**
 260   This function is used to program the resource allocated
 261   for each resource node under specified bridge.
 262
 263   @param Base     Base address of resource to be progammed.
 264   @param Bridge   PCI resource node for the bridge device.
 265
 266   @retval EFI_SUCCESS            Successfully to program all resouces
 267                                  on given PCI bridge device.
 268   @retval EFI_OUT_OF_RESOURCES   Base is all one.
 269
 270 **/
 271 EFI_STATUS
 272 ProgramResource (
 273   IN UINT64            Base,
 274   IN PCI_RESOURCE_NODE *Bridge
 275   );
 276
 277 /**
 278   Program Bar register for PCI device.
 279
 280   @param Base  Base address for PCI device resource to be progammed.
 281   @param Node  Point to resoure node structure.
 282
 283 **/
 284 VOID
 285 ProgramBar (
 286   IN UINT64            Base,
 287   IN PCI_RESOURCE_NODE *Node
 288   );
 289
 290 /**
 291   Program PCI-PCI bridge apperture.
 292
 293   @param Base  Base address for resource.
 294   @param Node  Point to resoure node structure.
 295
 296 **/
 297 VOID
 298 ProgramPpbApperture (
 299   IN UINT64            Base,
 300   IN PCI_RESOURCE_NODE *Node
 301   );
 302
 303 /**
 304   Program parent bridge for Option Rom.
 305
 306   @param PciDevice      Pci deivce instance.
 307   @param OptionRomBase  Base address for Optiona Rom.
 308   @param Enable         Enable or disable PCI memory.
 309
 310 **/
 311 VOID
 312 ProgrameUpstreamBridgeForRom (
 313   IN PCI_IO_DEVICE   *PciDevice,
 314   IN UINT32          OptionRomBase,
 315   IN BOOLEAN         Enable
 316   );
 317
 318 /**
 319   Test whether resource exists for a bridge.
 320
 321   @param Bridge  Point to resource node for a bridge.
 322
 323   @retval TRUE   There is resource on the given bridge.
 324   @retval FALSE  There isn't resource on the given bridge.
 325
 326 **/
 327 BOOLEAN
 328 ResourceRequestExisted (
 329   IN PCI_RESOURCE_NODE    *Bridge
 330   );
 331
 332 /**
 333   Initialize resource pool structure.
 334
 335   @param ResourcePool Point to resource pool structure. This pool
 336                       is reset to all zero when returned.
 337   @param ResourceType Type of resource.
 338
 339 **/
 340 VOID
 341 InitializeResourcePool (
 342   IN OUT PCI_RESOURCE_NODE   *ResourcePool,
 343   IN     PCI_BAR_TYPE        ResourceType
 344   );
 345
 346 /**
 347   Get all resource information for given Pci device.
 348
 349   @param PciDev         Pci device instance.
 350   @param IoBridge       Io resource node.
 351   @param Mem32Bridge    32-bit memory node.
 352   @param PMem32Bridge   32-bit Pmemory node.
 353   @param Mem64Bridge    64-bit memory node.
 354   @param PMem64Bridge   64-bit PMemory node.
 355   @param IoPool         Link list header for Io resource.
 356   @param Mem32Pool      Link list header for 32-bit memory.
 357   @param PMem32Pool     Link list header for 32-bit Prefetchable memory.
 358   @param Mem64Pool      Link list header for 64-bit memory.
 359   @param PMem64Pool     Link list header for 64-bit Prefetchable memory.
 360
 361 **/
 362 VOID
 363 GetResourceMap (
 364   IN PCI_IO_DEVICE      *PciDev,
 365   IN PCI_RESOURCE_NODE  **IoBridge,
 366   IN PCI_RESOURCE_NODE  **Mem32Bridge,
 367   IN PCI_RESOURCE_NODE  **PMem32Bridge,
 368   IN PCI_RESOURCE_NODE  **Mem64Bridge,
 369   IN PCI_RESOURCE_NODE  **PMem64Bridge,
 370   IN PCI_RESOURCE_NODE  *IoPool,
 371   IN PCI_RESOURCE_NODE  *Mem32Pool,
 372   IN PCI_RESOURCE_NODE  *PMem32Pool,
 373   IN PCI_RESOURCE_NODE  *Mem64Pool,
 374   IN PCI_RESOURCE_NODE  *PMem64Pool
 375   );
 376
 377 /**
 378   Destory given resource tree.
 379
 380   @param Bridge  PCI resource root node of resource tree.
 381
 382 **/
 383 VOID
 384 DestroyResourceTree (
 385   IN PCI_RESOURCE_NODE *Bridge
 386   );
 387
 388 /**
 389   Insert resource padding for P2C.
 390
 391   @param PciDev     Pci device instance.
 392   @param IoNode     Resource info node for IO.
 393   @param Mem32Node  Resource info node for 32-bit memory.
 394   @param PMem32Node Resource info node for 32-bit Prefetchable Memory.
 395   @param Mem64Node  Resource info node for 64-bit memory.
 396   @param PMem64Node Resource info node for 64-bit Prefetchable Memory.
 397
 398 **/
 399 VOID
 400 ResourcePaddingForCardBusBridge (
 401   IN PCI_IO_DEVICE        *PciDev,
 402   IN PCI_RESOURCE_NODE    *IoNode,
 403   IN PCI_RESOURCE_NODE    *Mem32Node,
 404   IN PCI_RESOURCE_NODE    *PMem32Node,
 405   IN PCI_RESOURCE_NODE    *Mem64Node,
 406   IN PCI_RESOURCE_NODE    *PMem64Node
 407   );
 408
 409 /**
 410   Program PCI Card device register for given resource node.
 411
 412   @param Base    Base address of PCI Card device to be programmed.
 413   @param Node    Given resource node.
 414
 415 **/
 416 VOID
 417 ProgramP2C (
 418   IN UINT64            Base,
 419   IN PCI_RESOURCE_NODE *Node
 420   );
 421
 422 /**
 423   Create padding resource node.
 424
 425   @param PciDev     Pci device instance.
 426   @param IoNode     Resource info node for IO.
 427   @param Mem32Node  Resource info node for 32-bit memory.
 428   @param PMem32Node Resource info node for 32-bit Prefetchable Memory.
 429   @param Mem64Node  Resource info node for 64-bit memory.
 430   @param PMem64Node Resource info node for 64-bit Prefetchable Memory.
 431
 432 **/
 433 VOID
 434 ApplyResourcePadding (
 435   IN PCI_IO_DEVICE         *PciDev,
 436   IN PCI_RESOURCE_NODE     *IoNode,
 437   IN PCI_RESOURCE_NODE     *Mem32Node,
 438   IN PCI_RESOURCE_NODE     *PMem32Node,
 439   IN PCI_RESOURCE_NODE     *Mem64Node,
 440   IN PCI_RESOURCE_NODE     *PMem64Node
 441   );
 442
 443 /**
 444   Get padding resource for PCI-PCI bridge.
 445
 446   @param  PciIoDevice     PCI-PCI bridge device instance.
 447
 448   @note   Feature flag PcdPciBusHotplugDeviceSupport determines
 449           whether need to pad resource for them.
 450 **/
 451 VOID
 452 GetResourcePaddingPpb (
 453   IN  PCI_IO_DEVICE                  *PciIoDevice
 454   );
 455
 456 #endif