Update For R9 Review.

[mirror_edk2.git] / IntelFrameworkModulePkg / Bus / Pci / PciBusDxe / PciResourceSupport.c

diff --git a/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciResourceSupport.c b/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciResourceSupport.c
index ab641e6691785aca00150f938d3572897a1ee01c..b40b01ea6fff224e87583ff27f05a94e11a24742 100644 (file)
--- a/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciResourceSupport.c
+++ b/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciResourceSupport.c
@@ -1,4 +1,4 @@
-/**@file\r
+/** @file\r
 \r
 Copyright (c) 2006 - 2008, Intel Corporation\r
 All rights reserved. This program and the accompanying materials\r
@@ -21,7 +21,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
   @param Start    address including VGA range\r
   @param Length   length of VGA range.\r
   \r
-  @retval EFI_SUCCESS success\r
+  @retval EFI_SUCCESS success.\r
 **/\r
 EFI_STATUS\r
 SkipVGAAperture (\r
@@ -50,12 +50,12 @@ SkipVGAAperture (
 }\r
 \r
 /**\r
-  This function is used to skip ISA aliasing aperture\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
+  @param Start    address including ISA aliasing aperture.\r
+  @param Length   length of ISA aliasing aperture.\r
   \r
-  @retval EFI_SUCCESS success\r
+  @retval EFI_SUCCESS success.\r
 **/\r
 EFI_STATUS\r
 SkipIsaAliasAperture (\r
@@ -89,10 +89,10 @@ SkipIsaAliasAperture (
   This function inserts a resource node into the resource list.\r
   The resource list is sorted in descend order.\r
 \r
-  @param Bridge  PCI resource node for bridge\r
-  @param ResNode Resource node want to be inserted\r
+  @param Bridge  PCI resource node for bridge.\r
+  @param ResNode Resource node want to be inserted.\r
   \r
-  @retval EFI_SUCCESS Success\r
+  @retval EFI_SUCCESS Success.\r
 **/\r
 EFI_STATUS\r
 InsertResourceNode (\r
@@ -141,13 +141,13 @@ Routine Description:
   If the TypeMerge is TRUE, Res resource type is changed to the type of destination resource\r
   type.\r
 \r
-  @param Dst        Point to destination resource tree\r
-  @param Res        Point to source resource tree\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
                     destination resource type.\r
                     \r
                     \r
-  @retval EFI_SUCCESS Success\r
+  @retval EFI_SUCCESS Success.\r
 **/\r
 EFI_STATUS\r
 MergeResourceTree (\r
@@ -183,7 +183,7 @@ MergeResourceTree (
 \r
   @param Bridge PCI resource node for bridge.\r
   \r
-  @retval EFI_SUCCESS Success\r
+  @retval EFI_SUCCESS Success.\r
 **/\r
 EFI_STATUS\r
 CalculateApertureIo16 (\r
@@ -311,11 +311,11 @@ CalculateApertureIo16 (
 \r
 /**\r
   This function is used to calculate the resource aperture\r
-  for a given bridge device\r
+  for a given bridge device.\r
 \r
-  @param Bridge Give bridge device\r
+  @param Bridge Give bridge device.\r
   \r
-  @retval EFI_SUCCESS Success\r
+  @retval EFI_SUCCESS Success.\r
 **/\r
 EFI_STATUS\r
 CalculateResourceAperture (\r
@@ -411,16 +411,16 @@ CalculateResourceAperture (
 }\r
 \r
 /**\r
-  Get IO/Memory resource infor for given PCI device\r
+  Get IO/Memory resource infor for given PCI device.\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 Mem64Node  Resource info node for 64-bit memory\r
-  @param PMem64Node Resource info node for 64-bit PMemory\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 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
+  @retval EFI_SUCCESS Success.\r
 **/\r
 EFI_STATUS\r
 GetResourceFromDevice (\r
@@ -558,14 +558,14 @@ GetResourceFromDevice (
 }\r
 \r
 /**\r
-  This function is used to create a resource node\r
-\r
-  @param PciDev       Pci device instance\r
-  @param Length       Length of Io/Memory resource\r
-  @param Alignment    Alignment of resource\r
-  @param Bar          Bar index \r
-  @param ResType      Type of resource: IO/Memory\r
-  @param ResUage      Resource usage\r
+  This function is used to create a resource node.\r
+\r
+  @param PciDev       Pci device instance.\r
+  @param Length       Length of Io/Memory resource.\r
+  @param Alignment    Alignment of resource.\r
+  @param Bar          Bar index.\r
+  @param ResType      Type of resource: IO/Memory.\r
+  @param ResUsage     Resource usage.\r
 **/\r
 PCI_RESOURCE_NODE *\r
 CreateResourceNode (\r
@@ -605,14 +605,14 @@ CreateResourceNode (
   This routine 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 Mem64Node  Resource info node for 64-bit memory\r
-  @param PMem64Node Resource info node for 64-bit PMemory\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 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
+  @retval EFI_SUCCESS Success.\r
 **/\r
 EFI_STATUS\r
 CreateResourceMap (\r
@@ -849,16 +849,16 @@ CreateResourceMap (
 }\r
 \r
 /**\r
-  This function is used to do the resource padding for a specific platform\r
+  This function is used to do the resource padding for a specific platform.\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 Mem64Node  Resource info node for 64-bit memory\r
-  @param PMem64Node Resource info node for 64-bit PMemory\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 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
+  @retval EFI_SUCCESS Success.\r
 **/\r
 EFI_STATUS\r
 ResourcePaddingPolicy (\r
@@ -893,16 +893,15 @@ ResourcePaddingPolicy (
   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 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 Mem64Node  Resource info node for 64-bit memory\r
-  @param PMem64Node Resource info node for 64-bit PMemory\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 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
+  @retval EFI_SUCCESS Success.\r
 **/\r
 EFI_STATUS\r
 DegradeResource (\r
@@ -1008,10 +1007,11 @@ DegradeResource (
 /**\r
   Test whether bridge device support decode resource\r
   \r
-  @param Bridge    Bridge device instance\r
-  @param Decode    Decode type according to resource type\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
+  @return TRUE  bridge device support decode resource.\r
+  @return FALSE bridge device don't support decode resource.\r
   \r
 **/\r
 BOOLEAN\r
@@ -1030,13 +1030,13 @@ BridgeSupportResourceDecode (
 \r
 /**\r
   This function is used to program the resource allocated \r
-  for each resource node\r
+  for each resource node.\r
 \r
   \r
-  @param Base     Base address of resource\r
-  @param Bridge   Bridge device instance\r
+  @param Base     Base address of resource.\r
+  @param Bridge   Bridge device instance.\r
   \r
-  @retval EFI_SUCCESS Success\r
+  @retval EFI_SUCCESS Success.\r
 **/\r
 EFI_STATUS\r
 ProgramResource (\r
@@ -1084,10 +1084,10 @@ ProgramResource (
 /**\r
   Program Bar register.\r
   \r
-  @param Base  Base address for resource\r
-  @param Node  Point to resoure node structure\r
+  @param Base  Base address for resource.\r
+  @param Node  Point to resoure node structure.\r
   \r
-  @retval EFI_SUCCESS Success\r
+  @retval EFI_SUCCESS Success.\r
 **/\r
 EFI_STATUS\r
 ProgramBar (\r
@@ -1166,12 +1166,12 @@ ProgramBar (
 }\r
 \r
 /**\r
-  Program PPB apperture\r
+  Program PPB apperture.\r
   \r
-  @param Base  Base address for resource\r
-  @param Node  Point to resoure node structure\r
+  @param Base  Base address for resource.\r
+  @param Node  Point to resoure node structure.\r
   \r
-  @retval EFI_SUCCESS Success\r
+  @retval EFI_SUCCESS Success.\r
 **/\r
 EFI_STATUS\r
 ProgramPpbApperture (\r
@@ -1340,13 +1340,13 @@ ProgramPpbApperture (
 }\r
 \r
 /**\r
-  Program parent bridge for oprom\r
+  Program parent bridge for oprom.\r
   \r
-  @param PciDevice      Pci deivce instance\r
-  @param OptionRomBase  Base address for oprom\r
-  @param Enable         Enable/Disable\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
+  @retval EFI_SUCCESS Success.\r
 **/\r
 EFI_STATUS\r
 ProgrameUpstreamBridgeForRom (\r
@@ -1392,11 +1392,11 @@ ProgrameUpstreamBridgeForRom (
 }\r
 \r
 /**\r
-  Test whether resource exists for a bridge\r
+  Test whether resource exists for a bridge.\r
   \r
-  @param Bridge  Point to resource node for a bridge \r
+  @param Bridge  Point to resource node for a bridge.\r
   \r
-  @return whether resource exists\r
+  @return whether resource exists.\r
 **/\r
 BOOLEAN\r
 ResourceRequestExisted (\r
@@ -1415,8 +1415,8 @@ ResourceRequestExisted (
 /**\r
   Initialize resource pool structure.\r
   \r
-  @param ResourcePool Point to resource pool structure\r
-  @param ResourceType Type of resource\r
+  @param ResourcePool Point to resource pool structure.\r
+  @param ResourceType Type of resource.\r
 **/\r
 EFI_STATUS\r
 InitializeResourcePool (\r
@@ -1434,21 +1434,21 @@ InitializeResourcePool (
 }\r
 \r
 /**\r
-  Get all resource information for given Pci device\r
+  Get all resource information for given Pci device.\r
   \r
-  @param PciDev         Pci device instance\r
-  @param IoBridge       Io resource node\r
-  @param Mem32Bridge    32-bit memory node\r
-  @param PMem32Bridge   32-bit Pmemory node\r
-  @param Mem64Bridge    64-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 Mem64Pool      Link list header for 64-bit memory\r
-  @param PMem64Pool     Link list header for 64-bit Pmemory\r
+  @param PciDev         Pci device instance.\r
+  @param IoBridge       Io resource node.\r
+  @param Mem32Bridge    32-bit memory node.\r
+  @param PMem32Bridge   32-bit Pmemory node.\r
+  @param Mem64Bridge    64-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 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
+  @retval EFI_SUCCESS Success.\r
 **/\r
 EFI_STATUS\r
 GetResourceMap (\r
@@ -1553,11 +1553,11 @@ GetResourceMap (
 }\r
 \r
 /**\r
-  Destory given resource tree\r
+  Destory given resource tree.\r
   \r
-  @param Bridge  root node of resource tree\r
+  @param Bridge  root node of resource tree.\r
   \r
-  @retval EFI_SUCCESS Success\r
+  @retval EFI_SUCCESS Success.\r
 **/\r
 EFI_STATUS\r
 DestroyResourceTree (\r
@@ -1588,10 +1588,10 @@ DestroyResourceTree (
 /**\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
+  @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
@@ -1619,16 +1619,16 @@ RecordReservedResource (
 }\r
 \r
 /**\r
-  Insert resource padding for P2C\r
+  Insert resource padding for P2C.\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 Mem64Node  Resource info node for 64-bit memory\r
-  @param PMem64Node Resource info node for 64-bit PMemory\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 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
+  @retval EFI_SUCCESS Success.\r
 **/\r
 EFI_STATUS\r
 ResourcePaddingForCardBusBridge (\r
@@ -1959,14 +1959,14 @@ ProgramP2C (
 /**\r
   Create padding resource node.\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 Mem64Node  Resource info node for 64-bit memory\r
-  @param PMem64Node Resource info node for 64-bit PMemory\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 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
+  @retval EFI_SUCCESS Success.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -2117,11 +2117,11 @@ ApplyResourcePadding (
 }\r
 \r
 /**\r
-  Get padding resource for PPB\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
+  So no need to pad resource for them.\r
 \r
-  @param   PciIoDevice Pci device instance\r
+  @param   PciIoDevice Pci device instance.\r
 **/\r
 VOID\r
 GetResourcePaddingPpb (\r