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. All rights reserved.<BR>
   5 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 PciDev       Pci device instance.
 183   @param Length       Length of Io/Memory resource.
 184   @param Alignment    Alignment of resource.
 185   @param Bar          Bar index.
 186   @param ResType      Type of resource: IO/Memory.
 187   @param ResUsage     Resource usage.
 188
 189   @return PCI resource node created for given PCI device.
 190           NULL means PCI resource node is not created.
 191
 192 **/
 193 PCI_RESOURCE_NODE *
 194 CreateVfResourceNode (
 195   IN PCI_IO_DEVICE         *PciDev,
 196   IN UINT64                Length,
 197   IN UINT64                Alignment,
 198   IN UINT8                 Bar,
 199   IN PCI_BAR_TYPE          ResType,
 200   IN PCI_RESOURCE_USAGE    ResUsage
 201   );
 202
 203 /**
 204   This function is used to extract resource request from
 205   device node list.
 206
 207   @param Bridge     Pci device instance.
 208   @param IoNode     Resource info node for IO.
 209   @param Mem32Node  Resource info node for 32-bit memory.
 210   @param PMem32Node Resource info node for 32-bit Prefetchable Memory.
 211   @param Mem64Node  Resource info node for 64-bit memory.
 212   @param PMem64Node Resource info node for 64-bit Prefetchable Memory.
 213
 214 **/
 215 VOID
 216 CreateResourceMap (
 217   IN     PCI_IO_DEVICE     *Bridge,
 218   IN OUT PCI_RESOURCE_NODE *IoNode,
 219   IN OUT PCI_RESOURCE_NODE *Mem32Node,
 220   IN OUT PCI_RESOURCE_NODE *PMem32Node,
 221   IN OUT PCI_RESOURCE_NODE *Mem64Node,
 222   IN OUT PCI_RESOURCE_NODE *PMem64Node
 223   );
 224
 225 /**
 226   This function is used to do the resource padding for a specific platform.
 227
 228   @param PciDev     Pci device instance.
 229   @param IoNode     Resource info node for IO.
 230   @param Mem32Node  Resource info node for 32-bit memory.
 231   @param PMem32Node Resource info node for 32-bit Prefetchable Memory.
 232   @param Mem64Node  Resource info node for 64-bit memory.
 233   @param PMem64Node Resource info node for 64-bit Prefetchable Memory.
 234
 235 **/
 236 VOID
 237 ResourcePaddingPolicy (
 238   IN PCI_IO_DEVICE     *PciDev,
 239   IN PCI_RESOURCE_NODE *IoNode,
 240   IN PCI_RESOURCE_NODE *Mem32Node,
 241   IN PCI_RESOURCE_NODE *PMem32Node,
 242   IN PCI_RESOURCE_NODE *Mem64Node,
 243   IN PCI_RESOURCE_NODE *PMem64Node
 244   );
 245
 246 /**
 247   This function is used to degrade resource if the upstream bridge
 248   doesn't support certain resource. Degradation path is
 249   PMEM64 -> MEM64  -> MEM32
 250   PMEM64 -> PMEM32 -> MEM32
 251   IO32   -> IO16.
 252
 253   @param Bridge     Pci device instance.
 254   @param Mem32Node  Resource info node for 32-bit memory.
 255   @param PMem32Node Resource info node for 32-bit Prefetchable Memory.
 256   @param Mem64Node  Resource info node for 64-bit memory.
 257   @param PMem64Node Resource info node for 64-bit Prefetchable Memory.
 258
 259 **/
 260 VOID
 261 DegradeResource (
 262   IN PCI_IO_DEVICE     *Bridge,
 263   IN PCI_RESOURCE_NODE *Mem32Node,
 264   IN PCI_RESOURCE_NODE *PMem32Node,
 265   IN PCI_RESOURCE_NODE *Mem64Node,
 266   IN PCI_RESOURCE_NODE *PMem64Node
 267   );
 268
 269 /**
 270   Test whether bridge device support decode resource.
 271
 272   @param Bridge    Bridge device instance.
 273   @param Decode    Decode type according to resource type.
 274
 275   @return TRUE     The bridge device support decode resource.
 276   @return FALSE    The bridge device don't support decode resource.
 277
 278 **/
 279 BOOLEAN
 280 BridgeSupportResourceDecode (
 281   IN PCI_IO_DEVICE *Bridge,
 282   IN UINT32        Decode
 283   );
 284
 285 /**
 286   This function is used to program the resource allocated
 287   for each resource node under specified bridge.
 288
 289   @param Base     Base address of resource to be progammed.
 290   @param Bridge   PCI resource node for the bridge device.
 291
 292   @retval EFI_SUCCESS            Successfully to program all resouces
 293                                  on given PCI bridge device.
 294   @retval EFI_OUT_OF_RESOURCES   Base is all one.
 295
 296 **/
 297 EFI_STATUS
 298 ProgramResource (
 299   IN UINT64            Base,
 300   IN PCI_RESOURCE_NODE *Bridge
 301   );
 302
 303 /**
 304   Program Bar register for PCI device.
 305
 306   @param Base  Base address for PCI device resource to be progammed.
 307   @param Node  Point to resoure node structure.
 308
 309 **/
 310 VOID
 311 ProgramBar (
 312   IN UINT64            Base,
 313   IN PCI_RESOURCE_NODE *Node
 314   );
 315
 316 /**
 317   Program IOV VF Bar register for PCI device.
 318
 319   @param Base  Base address for PCI device resource to be progammed.
 320   @param Node  Point to resoure node structure.
 321
 322 **/
 323 EFI_STATUS
 324 ProgramVfBar (
 325   IN UINT64            Base,
 326   IN PCI_RESOURCE_NODE *Node
 327   );
 328
 329 /**
 330   Program PCI-PCI bridge apperture.
 331
 332   @param Base  Base address for resource.
 333   @param Node  Point to resoure node structure.
 334
 335 **/
 336 VOID
 337 ProgramPpbApperture (
 338   IN UINT64            Base,
 339   IN PCI_RESOURCE_NODE *Node
 340   );
 341
 342 /**
 343   Program parent bridge for Option Rom.
 344
 345   @param PciDevice      Pci deivce instance.
 346   @param OptionRomBase  Base address for Optiona Rom.
 347   @param Enable         Enable or disable PCI memory.
 348
 349 **/
 350 VOID
 351 ProgrameUpstreamBridgeForRom (
 352   IN PCI_IO_DEVICE   *PciDevice,
 353   IN UINT32          OptionRomBase,
 354   IN BOOLEAN         Enable
 355   );
 356
 357 /**
 358   Test whether resource exists for a bridge.
 359
 360   @param Bridge  Point to resource node for a bridge.
 361
 362   @retval TRUE   There is resource on the given bridge.
 363   @retval FALSE  There isn't resource on the given bridge.
 364
 365 **/
 366 BOOLEAN
 367 ResourceRequestExisted (
 368   IN PCI_RESOURCE_NODE    *Bridge
 369   );
 370
 371 /**
 372   Initialize resource pool structure.
 373
 374   @param ResourcePool Point to resource pool structure. This pool
 375                       is reset to all zero when returned.
 376   @param ResourceType Type of resource.
 377
 378 **/
 379 VOID
 380 InitializeResourcePool (
 381   IN OUT PCI_RESOURCE_NODE   *ResourcePool,
 382   IN     PCI_BAR_TYPE        ResourceType
 383   );
 384
 385 /**
 386   Get all resource information for given Pci device.
 387
 388   @param PciDev         Pci device instance.
 389   @param IoBridge       Io resource node.
 390   @param Mem32Bridge    32-bit memory node.
 391   @param PMem32Bridge   32-bit Pmemory node.
 392   @param Mem64Bridge    64-bit memory node.
 393   @param PMem64Bridge   64-bit PMemory node.
 394   @param IoPool         Link list header for Io resource.
 395   @param Mem32Pool      Link list header for 32-bit memory.
 396   @param PMem32Pool     Link list header for 32-bit Prefetchable memory.
 397   @param Mem64Pool      Link list header for 64-bit memory.
 398   @param PMem64Pool     Link list header for 64-bit Prefetchable memory.
 399
 400 **/
 401 VOID
 402 GetResourceMap (
 403   IN PCI_IO_DEVICE      *PciDev,
 404   IN PCI_RESOURCE_NODE  **IoBridge,
 405   IN PCI_RESOURCE_NODE  **Mem32Bridge,
 406   IN PCI_RESOURCE_NODE  **PMem32Bridge,
 407   IN PCI_RESOURCE_NODE  **Mem64Bridge,
 408   IN PCI_RESOURCE_NODE  **PMem64Bridge,
 409   IN PCI_RESOURCE_NODE  *IoPool,
 410   IN PCI_RESOURCE_NODE  *Mem32Pool,
 411   IN PCI_RESOURCE_NODE  *PMem32Pool,
 412   IN PCI_RESOURCE_NODE  *Mem64Pool,
 413   IN PCI_RESOURCE_NODE  *PMem64Pool
 414   );
 415
 416 /**
 417   Destory given resource tree.
 418
 419   @param Bridge  PCI resource root node of resource tree.
 420
 421 **/
 422 VOID
 423 DestroyResourceTree (
 424   IN PCI_RESOURCE_NODE *Bridge
 425   );
 426
 427 /**
 428   Insert resource padding for P2C.
 429
 430   @param PciDev     Pci device instance.
 431   @param IoNode     Resource info node for IO.
 432   @param Mem32Node  Resource info node for 32-bit memory.
 433   @param PMem32Node Resource info node for 32-bit Prefetchable Memory.
 434   @param Mem64Node  Resource info node for 64-bit memory.
 435   @param PMem64Node Resource info node for 64-bit Prefetchable Memory.
 436
 437 **/
 438 VOID
 439 ResourcePaddingForCardBusBridge (
 440   IN PCI_IO_DEVICE        *PciDev,
 441   IN PCI_RESOURCE_NODE    *IoNode,
 442   IN PCI_RESOURCE_NODE    *Mem32Node,
 443   IN PCI_RESOURCE_NODE    *PMem32Node,
 444   IN PCI_RESOURCE_NODE    *Mem64Node,
 445   IN PCI_RESOURCE_NODE    *PMem64Node
 446   );
 447
 448 /**
 449   Program PCI Card device register for given resource node.
 450
 451   @param Base    Base address of PCI Card device to be programmed.
 452   @param Node    Given resource node.
 453
 454 **/
 455 VOID
 456 ProgramP2C (
 457   IN UINT64            Base,
 458   IN PCI_RESOURCE_NODE *Node
 459   );
 460
 461 /**
 462   Create padding resource node.
 463
 464   @param PciDev     Pci device instance.
 465   @param IoNode     Resource info node for IO.
 466   @param Mem32Node  Resource info node for 32-bit memory.
 467   @param PMem32Node Resource info node for 32-bit Prefetchable Memory.
 468   @param Mem64Node  Resource info node for 64-bit memory.
 469   @param PMem64Node Resource info node for 64-bit Prefetchable Memory.
 470
 471 **/
 472 VOID
 473 ApplyResourcePadding (
 474   IN PCI_IO_DEVICE         *PciDev,
 475   IN PCI_RESOURCE_NODE     *IoNode,
 476   IN PCI_RESOURCE_NODE     *Mem32Node,
 477   IN PCI_RESOURCE_NODE     *PMem32Node,
 478   IN PCI_RESOURCE_NODE     *Mem64Node,
 479   IN PCI_RESOURCE_NODE     *PMem64Node
 480   );
 481
 482 /**
 483   Get padding resource for PCI-PCI bridge.
 484
 485   @param  PciIoDevice     PCI-PCI bridge device instance.
 486
 487   @note   Feature flag PcdPciBusHotplugDeviceSupport determines
 488           whether need to pad resource for them.
 489 **/
 490 VOID
 491 GetResourcePaddingPpb (
 492   IN  PCI_IO_DEVICE                  *PciIoDevice
 493   );
 494
 495 #endif