/** @file\r
+ PCI resouces support functions declaration for PCI Bus module.\r
\r
-Copyright (c) 2006, Intel Corporation \r
-All rights reserved. This program and the accompanying materials \r
-are licensed and made available under the terms and conditions of the BSD License \r
-which accompanies this distribution. The full text of the license may be found at \r
-http://opensource.org/licenses/bsd-license.php \r
- \r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
+Copyright (c) 2006 - 2009, Intel Corporation\r
+All rights reserved. This program and the accompanying materials\r
+are licensed and made available under the terms and conditions of the BSD License\r
+which accompanies this distribution. The full text of the license may be found at\r
+http://opensource.org/licenses/bsd-license.php\r
+\r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#ifndef _EFI_PCI_RESOURCE_SUPPORT_H_\r
#define _EFI_PCI_RESOURCE_SUPPORT_H_\r
\r
-#define RESERVED_RESOURCE_SIGNATURE SIGNATURE_32 ('r', 's', 'v', 'd')\r
-\r
-typedef struct {\r
- UINT64 Base;\r
- UINT64 Length;\r
- PCI_BAR_TYPE ResType;\r
-} PCI_RESERVED_RESOURCE_NODE;\r
-\r
-typedef struct {\r
- UINT32 Signature;\r
- LIST_ENTRY Link;\r
- PCI_RESERVED_RESOURCE_NODE Node;\r
-} PCI_RESERVED_RESOURCE_LIST;\r
-\r
-#define RESOURCED_LIST_FROM_NODE(a) \\r
- CR (a, PCI_RESERVED_RESOURCE_LIST, Node, RESERVED_RESOURCE_SIGNATURE)\r
-\r
-#define RESOURCED_LIST_FROM_LINK(a) \\r
- CR (a, PCI_RESERVED_RESOURCE_LIST, Link, RESERVED_RESOURCE_SIGNATURE)\r
-\r
typedef enum {\r
PciResUsageTypical = 0,\r
PciResUsagePadding,\r
CR (a, PCI_RESOURCE_NODE, Link, PCI_RESOURCE_SIGNATURE)\r
\r
/**\r
- The function is used to skip VGA range\r
- \r
- @param Start address including VGA range\r
- @param Length length of VGA range.\r
- \r
- @retval EFI_SUCCESS success.\r
+ The function is used to skip VGA range.\r
+\r
+ @param Start Returned start address including VGA range.\r
+ @param Length The length of VGA range.\r
+\r
**/\r
-EFI_STATUS\r
+VOID\r
SkipVGAAperture (\r
OUT UINT64 *Start,\r
IN UINT64 Length\r
\r
/**\r
This function is used to skip ISA aliasing aperture.\r
- \r
- @param Start address including ISA aliasing aperture.\r
- @param Length length of ISA aliasing aperture.\r
- \r
- @retval EFI_SUCCESS success.\r
+\r
+ @param Start Returned start address including ISA aliasing aperture.\r
+ @param Length The length of ISA aliasing aperture.\r
+\r
**/\r
-EFI_STATUS\r
+VOID\r
SkipIsaAliasAperture (\r
OUT UINT64 *Start,\r
IN UINT64 Length\r
\r
@param Bridge PCI resource node for bridge.\r
@param ResNode Resource node want to be inserted.\r
- \r
- @retval EFI_SUCCESS Success.\r
+\r
**/\r
-EFI_STATUS\r
+VOID\r
InsertResourceNode (\r
- PCI_RESOURCE_NODE *Bridge,\r
- PCI_RESOURCE_NODE *ResNode\r
+ IN OUT PCI_RESOURCE_NODE *Bridge,\r
+ IN PCI_RESOURCE_NODE *ResNode\r
);\r
\r
/**\r
+ This routine is used to merge two different resource trees in need of\r
+ resoure degradation.\r
\r
-Routine Description:\r
-\r
- This routine is used to merge two different resource tree in need of\r
- resoure degradation. For example, if a upstream PPB doesn't support,\r
+ For example, if an upstream PPB doesn't support,\r
prefetchable memory decoding, the PCI bus driver will choose to call this function\r
to merge prefectchable memory resource list into normal memory list.\r
\r
If the TypeMerge is TRUE, Res resource type is changed to the type of destination resource\r
type.\r
+ If Dst is NULL or Res is NULL, ASSERT ().\r
\r
@param Dst Point to destination resource tree.\r
@param Res Point to source resource tree.\r
- @param TypeMerge If the TypeMerge is TRUE, Res resource type is changed to the type of \r
+ @param TypeMerge If the TypeMerge is TRUE, Res resource type is changed to the type of\r
destination resource type.\r
- \r
- \r
- @retval EFI_SUCCESS Success\r
+\r
**/\r
-EFI_STATUS\r
+VOID\r
MergeResourceTree (\r
- PCI_RESOURCE_NODE *Dst,\r
- PCI_RESOURCE_NODE *Res,\r
- BOOLEAN TypeMerge\r
+ IN PCI_RESOURCE_NODE *Dst,\r
+ IN PCI_RESOURCE_NODE *Res,\r
+ IN BOOLEAN TypeMerge\r
);\r
\r
/**\r
This function is used to calculate the IO16 aperture\r
for a bridge.\r
\r
- @param Bridge PCI resource node for bridge.\r
- \r
- @retval EFI_SUCCESS Success.\r
+ @param Bridge PCI resource node for bridge.\r
+\r
**/\r
-EFI_STATUS\r
+VOID\r
CalculateApertureIo16 (\r
- IN PCI_RESOURCE_NODE *Bridge\r
+ IN PCI_RESOURCE_NODE *Bridge\r
);\r
\r
/**\r
This function is used to calculate the resource aperture\r
for a given bridge device.\r
\r
- @param Bridge Give bridge device.\r
- \r
- @retval EFI_SUCCESS Success.\r
+ @param Bridge PCI resouce node for given bridge device.\r
+\r
**/\r
-EFI_STATUS\r
+VOID\r
CalculateResourceAperture (\r
- IN PCI_RESOURCE_NODE *Bridge\r
+ IN PCI_RESOURCE_NODE *Bridge\r
);\r
\r
/**\r
Get IO/Memory resource infor for given PCI device.\r
- \r
+\r
@param PciDev Pci device instance.\r
@param IoNode Resource info node for IO .\r
@param Mem32Node Resource info node for 32-bit memory.\r
- @param PMem32Node Resource info node for 32-bit PMemory.\r
+ @param PMem32Node Resource info node for 32-bit Prefetchable Memory.\r
@param Mem64Node Resource info node for 64-bit memory.\r
- @param PMem64Node Resource info node for 64-bit PMemory.\r
- \r
- @retval EFI_SUCCESS Success.\r
+ @param PMem64Node Resource info node for 64-bit Prefetchable Memory.\r
+\r
**/\r
-EFI_STATUS\r
+VOID\r
GetResourceFromDevice (\r
- PCI_IO_DEVICE *PciDev,\r
- PCI_RESOURCE_NODE *IoNode,\r
- PCI_RESOURCE_NODE *Mem32Node,\r
- PCI_RESOURCE_NODE *PMem32Node,\r
- PCI_RESOURCE_NODE *Mem64Node,\r
- PCI_RESOURCE_NODE *PMem64Node\r
+ IN PCI_IO_DEVICE *PciDev,\r
+ IN OUT PCI_RESOURCE_NODE *IoNode,\r
+ IN OUT PCI_RESOURCE_NODE *Mem32Node,\r
+ IN OUT PCI_RESOURCE_NODE *PMem32Node,\r
+ IN OUT PCI_RESOURCE_NODE *Mem64Node,\r
+ IN OUT PCI_RESOURCE_NODE *PMem64Node\r
);\r
\r
/**\r
@param Bar Bar index.\r
@param ResType Type of resource: IO/Memory.\r
@param ResUsage Resource usage.\r
+\r
+ @return PCI resource node created for given PCI device.\r
+ NULL means PCI resource node is not created.\r
+\r
**/\r
PCI_RESOURCE_NODE *\r
CreateResourceNode (\r
);\r
\r
/**\r
- This routine is used to extract resource request from\r
+ This function is used to extract resource request from\r
device node list.\r
\r
@param Bridge Pci device instance.\r
@param IoNode Resource info node for IO.\r
@param Mem32Node Resource info node for 32-bit memory.\r
- @param PMem32Node Resource info node for 32-bit PMemory.\r
+ @param PMem32Node Resource info node for 32-bit Prefetchable Memory.\r
@param Mem64Node Resource info node for 64-bit memory.\r
- @param PMem64Node Resource info node for 64-bit PMemory.\r
+ @param PMem64Node Resource info node for 64-bit Prefetchable Memory.\r
\r
- @retval EFI_SUCCESS Success.\r
**/\r
-EFI_STATUS\r
+VOID\r
CreateResourceMap (\r
- IN PCI_IO_DEVICE *Bridge,\r
- IN PCI_RESOURCE_NODE *IoNode,\r
- IN PCI_RESOURCE_NODE *Mem32Node,\r
- IN PCI_RESOURCE_NODE *PMem32Node,\r
- IN PCI_RESOURCE_NODE *Mem64Node,\r
- IN PCI_RESOURCE_NODE *PMem64Node\r
+ IN PCI_IO_DEVICE *Bridge,\r
+ IN OUT PCI_RESOURCE_NODE *IoNode,\r
+ IN OUT PCI_RESOURCE_NODE *Mem32Node,\r
+ IN OUT PCI_RESOURCE_NODE *PMem32Node,\r
+ IN OUT PCI_RESOURCE_NODE *Mem64Node,\r
+ IN OUT PCI_RESOURCE_NODE *PMem64Node\r
);\r
\r
/**\r
This function is used to do the resource padding for a specific platform.\r
\r
@param PciDev Pci device instance.\r
- @param IoNode Resource info node for IO. \r
+ @param IoNode Resource info node for IO.\r
@param Mem32Node Resource info node for 32-bit memory.\r
- @param PMem32Node Resource info node for 32-bit PMemory.\r
+ @param PMem32Node Resource info node for 32-bit Prefetchable Memory.\r
@param Mem64Node Resource info node for 64-bit memory.\r
- @param PMem64Node Resource info node for 64-bit PMemory.\r
+ @param PMem64Node Resource info node for 64-bit Prefetchable Memory.\r
\r
- @retval EFI_SUCCESS Success.\r
**/\r
-EFI_STATUS\r
+VOID\r
ResourcePaddingPolicy (\r
- PCI_IO_DEVICE *PciDev,\r
- PCI_RESOURCE_NODE *IoNode,\r
- PCI_RESOURCE_NODE *Mem32Node,\r
- PCI_RESOURCE_NODE *PMem32Node,\r
- PCI_RESOURCE_NODE *Mem64Node,\r
- PCI_RESOURCE_NODE *PMem64Node\r
+ IN PCI_IO_DEVICE *PciDev,\r
+ IN PCI_RESOURCE_NODE *IoNode,\r
+ IN PCI_RESOURCE_NODE *Mem32Node,\r
+ IN PCI_RESOURCE_NODE *PMem32Node,\r
+ IN PCI_RESOURCE_NODE *Mem64Node,\r
+ IN PCI_RESOURCE_NODE *PMem64Node\r
);\r
\r
/**\r
- This function is used to degrade resource if the upstream bridge \r
- doesn't support certain resource. Degradation path is \r
+ This function is used to degrade resource if the upstream bridge\r
+ doesn't support certain resource. Degradation path is\r
PMEM64 -> MEM64 -> MEM32\r
PMEM64 -> PMEM32 -> MEM32\r
- IO32 -> IO16\r
+ IO32 -> IO16.\r
\r
@param Bridge Pci device instance.\r
@param Mem32Node Resource info node for 32-bit memory.\r
- @param PMem32Node Resource info node for 32-bit PMemory.\r
+ @param PMem32Node Resource info node for 32-bit Prefetchable Memory.\r
@param Mem64Node Resource info node for 64-bit memory.\r
- @param PMem64Node Resource info node for 64-bit PMemory.\r
+ @param PMem64Node Resource info node for 64-bit Prefetchable Memory.\r
\r
- @retval EFI_SUCCESS Success.\r
**/\r
-EFI_STATUS\r
+VOID\r
DegradeResource (\r
IN PCI_IO_DEVICE *Bridge,\r
IN PCI_RESOURCE_NODE *Mem32Node,\r
\r
/**\r
Test whether bridge device support decode resource.\r
- \r
+\r
@param Bridge Bridge device instance.\r
@param Decode Decode type according to resource type.\r
- \r
- @return whether bridge device support decode resource.\r
- \r
+\r
+ @return TRUE The bridge device support decode resource.\r
+ @return FALSE The bridge device don't support decode resource.\r
+\r
**/\r
BOOLEAN\r
BridgeSupportResourceDecode (\r
);\r
\r
/**\r
- This function is used to program the resource allocated \r
- for each resource node.\r
-\r
- \r
- @param Base Base address of resource.\r
- @param Bridge Bridge device instance.\r
- \r
- @retval EFI_SUCCESS Success.\r
+ This function is used to program the resource allocated\r
+ for each resource node under specified bridge.\r
+\r
+ @param Base Base address of resource to be progammed.\r
+ @param Bridge PCI resource node for the bridge device.\r
+\r
+ @retval EFI_SUCCESS Successfully to program all resouces\r
+ on given PCI bridge device.\r
+ @retval EFI_OUT_OF_RESOURCES Base is all one.\r
+\r
**/\r
EFI_STATUS\r
ProgramResource (\r
);\r
\r
/**\r
- Program Bar register.\r
- \r
- @param Base Base address for resource.\r
+ Program Bar register for PCI device.\r
+\r
+ @param Base Base address for PCI device resource to be progammed.\r
@param Node Point to resoure node structure.\r
- \r
- @retval EFI_SUCCESS Success.\r
+\r
**/\r
-EFI_STATUS\r
+VOID\r
ProgramBar (\r
IN UINT64 Base,\r
IN PCI_RESOURCE_NODE *Node\r
);\r
\r
/**\r
- Program PPB apperture.\r
- \r
+ Program PCI-PCI bridge apperture.\r
+\r
@param Base Base address for resource.\r
@param Node Point to resoure node structure.\r
- \r
- @retval EFI_SUCCESS Success.\r
+\r
**/\r
-EFI_STATUS\r
+VOID\r
ProgramPpbApperture (\r
IN UINT64 Base,\r
IN PCI_RESOURCE_NODE *Node\r
);\r
\r
/**\r
- Program parent bridge for oprom.\r
- \r
+ Program parent bridge for Option Rom.\r
+\r
@param PciDevice Pci deivce instance.\r
- @param OptionRomBase Base address for oprom.\r
- @param Enable Enable/Disable.\r
- \r
- @retval EFI_SUCCESS Success.\r
+ @param OptionRomBase Base address for Optiona Rom.\r
+ @param Enable Enable or disable PCI memory.\r
+\r
**/\r
-EFI_STATUS\r
+VOID\r
ProgrameUpstreamBridgeForRom (\r
IN PCI_IO_DEVICE *PciDevice,\r
IN UINT32 OptionRomBase,\r
\r
/**\r
Test whether resource exists for a bridge.\r
- \r
+\r
@param Bridge Point to resource node for a bridge.\r
- \r
- @return whether resource exists.\r
+\r
+ @retval TRUE There is resource on the given bridge.\r
+ @retval FALSE There isn't resource on the given bridge.\r
+\r
**/\r
BOOLEAN\r
ResourceRequestExisted (\r
- IN PCI_RESOURCE_NODE *Bridge\r
+ IN PCI_RESOURCE_NODE *Bridge\r
);\r
\r
/**\r
Initialize resource pool structure.\r
- \r
- @param ResourcePool Point to resource pool structure.\r
+\r
+ @param ResourcePool Point to resource pool structure. This pool\r
+ is reset to all zero when returned.\r
@param ResourceType Type of resource.\r
+\r
**/\r
-EFI_STATUS\r
+VOID\r
InitializeResourcePool (\r
- PCI_RESOURCE_NODE *ResourcePool,\r
- PCI_BAR_TYPE ResourceType\r
+ IN OUT PCI_RESOURCE_NODE *ResourcePool,\r
+ IN PCI_BAR_TYPE ResourceType\r
);\r
\r
/**\r
Get all resource information for given Pci device.\r
- \r
+\r
@param PciDev Pci device instance.\r
@param IoBridge Io resource node.\r
@param Mem32Bridge 32-bit memory node.\r
@param PMem64Bridge 64-bit PMemory node.\r
@param IoPool Link list header for Io resource.\r
@param Mem32Pool Link list header for 32-bit memory.\r
- @param PMem32Pool Link list header for 32-bit Pmemory.\r
+ @param PMem32Pool Link list header for 32-bit Prefetchable memory.\r
@param Mem64Pool Link list header for 64-bit memory.\r
- @param PMem64Pool Link list header for 64-bit Pmemory.\r
- \r
- @retval EFI_SUCCESS Success.\r
+ @param PMem64Pool Link list header for 64-bit Prefetchable memory.\r
+\r
**/\r
-EFI_STATUS\r
+VOID\r
GetResourceMap (\r
- PCI_IO_DEVICE *PciDev,\r
- PCI_RESOURCE_NODE **IoBridge,\r
- PCI_RESOURCE_NODE **Mem32Bridge,\r
- PCI_RESOURCE_NODE **PMem32Bridge,\r
- PCI_RESOURCE_NODE **Mem64Bridge,\r
- PCI_RESOURCE_NODE **PMem64Bridge,\r
- PCI_RESOURCE_NODE *IoPool,\r
- PCI_RESOURCE_NODE *Mem32Pool,\r
- PCI_RESOURCE_NODE *PMem32Pool,\r
- PCI_RESOURCE_NODE *Mem64Pool,\r
- PCI_RESOURCE_NODE *PMem64Pool\r
+ IN PCI_IO_DEVICE *PciDev,\r
+ IN PCI_RESOURCE_NODE **IoBridge,\r
+ IN PCI_RESOURCE_NODE **Mem32Bridge,\r
+ IN PCI_RESOURCE_NODE **PMem32Bridge,\r
+ IN PCI_RESOURCE_NODE **Mem64Bridge,\r
+ IN PCI_RESOURCE_NODE **PMem64Bridge,\r
+ IN PCI_RESOURCE_NODE *IoPool,\r
+ IN PCI_RESOURCE_NODE *Mem32Pool,\r
+ IN PCI_RESOURCE_NODE *PMem32Pool,\r
+ IN PCI_RESOURCE_NODE *Mem64Pool,\r
+ IN PCI_RESOURCE_NODE *PMem64Pool\r
);\r
\r
/**\r
Destory given resource tree.\r
- \r
- @param Bridge root node of resource tree.\r
- \r
- @retval EFI_SUCCESS Success.\r
+\r
+ @param Bridge PCI resource root node of resource tree.\r
+\r
**/\r
-EFI_STATUS\r
+VOID\r
DestroyResourceTree (\r
IN PCI_RESOURCE_NODE *Bridge\r
);\r
\r
-/**\r
- Record the reserved resource and insert to reserved list.\r
- \r
- @param Base Base address of reserved resourse.\r
- @param Length Length of reserved resource.\r
- @param ResType Resource type.\r
- @param Bridge Pci device instance.\r
-**/\r
-EFI_STATUS\r
-RecordReservedResource (\r
- IN UINT64 Base,\r
- IN UINT64 Length,\r
- IN PCI_BAR_TYPE ResType,\r
- IN PCI_IO_DEVICE *Bridge\r
- );\r
-\r
/**\r
Insert resource padding for P2C.\r
- \r
+\r
@param PciDev Pci device instance.\r
- @param IoNode Resource info node for IO. \r
+ @param IoNode Resource info node for IO.\r
@param Mem32Node Resource info node for 32-bit memory.\r
- @param PMem32Node Resource info node for 32-bit PMemory.\r
+ @param PMem32Node Resource info node for 32-bit Prefetchable Memory.\r
@param Mem64Node Resource info node for 64-bit memory.\r
- @param PMem64Node Resource info node for 64-bit PMemory.\r
- \r
- @retval EFI_SUCCESS Success.\r
+ @param PMem64Node Resource info node for 64-bit Prefetchable Memory.\r
+\r
**/\r
-EFI_STATUS\r
+VOID\r
ResourcePaddingForCardBusBridge (\r
- PCI_IO_DEVICE *PciDev,\r
- PCI_RESOURCE_NODE *IoNode,\r
- PCI_RESOURCE_NODE *Mem32Node,\r
- PCI_RESOURCE_NODE *PMem32Node,\r
- PCI_RESOURCE_NODE *Mem64Node,\r
- PCI_RESOURCE_NODE *PMem64Node\r
+ IN PCI_IO_DEVICE *PciDev,\r
+ IN PCI_RESOURCE_NODE *IoNode,\r
+ IN PCI_RESOURCE_NODE *Mem32Node,\r
+ IN PCI_RESOURCE_NODE *PMem32Node,\r
+ IN PCI_RESOURCE_NODE *Mem64Node,\r
+ IN PCI_RESOURCE_NODE *PMem64Node\r
);\r
\r
/**\r
- Program P2C register for given resource node.\r
- \r
- @param Base Base address of P2C device.\r
+ Program PCI Card device register for given resource node.\r
+\r
+ @param Base Base address of PCI Card device to be programmed.\r
@param Node Given resource node.\r
- \r
- @retval EFI_SUCCESS Success.\r
+\r
**/\r
-EFI_STATUS\r
+VOID\r
ProgramP2C (\r
IN UINT64 Base,\r
IN PCI_RESOURCE_NODE *Node\r
\r
/**\r
Create padding resource node.\r
- \r
+\r
@param PciDev Pci device instance.\r
- @param IoNode Resource info node for IO. \r
+ @param IoNode Resource info node for IO.\r
@param Mem32Node Resource info node for 32-bit memory.\r
- @param PMem32Node Resource info node for 32-bit PMemory.\r
+ @param PMem32Node Resource info node for 32-bit Prefetchable Memory.\r
@param Mem64Node Resource info node for 64-bit memory.\r
- @param PMem64Node Resource info node for 64-bit PMemory.\r
- \r
- @retval EFI_SUCCESS Success\r
+ @param PMem64Node Resource info node for 64-bit Prefetchable Memory.\r
\r
**/\r
-EFI_STATUS\r
+VOID\r
ApplyResourcePadding (\r
- PCI_IO_DEVICE *PciDev,\r
- PCI_RESOURCE_NODE *IoNode,\r
- PCI_RESOURCE_NODE *Mem32Node,\r
- PCI_RESOURCE_NODE *PMem32Node,\r
- PCI_RESOURCE_NODE *Mem64Node,\r
- PCI_RESOURCE_NODE *PMem64Node\r
+ IN PCI_IO_DEVICE *PciDev,\r
+ IN PCI_RESOURCE_NODE *IoNode,\r
+ IN PCI_RESOURCE_NODE *Mem32Node,\r
+ IN PCI_RESOURCE_NODE *PMem32Node,\r
+ IN PCI_RESOURCE_NODE *Mem64Node,\r
+ IN PCI_RESOURCE_NODE *PMem64Node\r
);\r
\r
/**\r
- Get padding resource for PPB\r
- Light PCI bus driver woundn't support hotplug root device\r
- So no need to pad resource for them.\r
+ Get padding resource for PCI-PCI bridge.\r
+\r
+ @param PciIoDevice PCI-PCI bridge device instance.\r
\r
- @param PciIoDevice Pci device instance.\r
+ @note Feature flag PcdPciBusHotplugDeviceSupport determines\r
+ whether need to pad resource for them.\r
**/\r
VOID\r
GetResourcePaddingPpb (\r
IN PCI_IO_DEVICE *PciIoDevice\r
);\r
\r
-/**\r
- Reset and all bus number from specific bridge.\r
- \r
- @param Bridge Parent specific bridge.\r
- @param StartBusNumber start bus number.\r
-**/\r
-EFI_STATUS\r
-ResetAllPpbBusNumber (\r
- IN PCI_IO_DEVICE *Bridge,\r
- IN UINT8 StartBusNumber\r
- );\r
-\r
#endif\r
projects / mirror_edk2.git / blobdiff