]> git.proxmox.com Git - mirror_edk2.git/commitdiff
Function headers in .h and .c files synchronized with spec
authorjji4 <jji4@6f19259b-4bc3-4df7-8a09-765794883524>
Fri, 28 Nov 2008 02:18:02 +0000 (02:18 +0000)
committerjji4 <jji4@6f19259b-4bc3-4df7-8a09-765794883524>
Fri, 28 Nov 2008 02:18:02 +0000 (02:18 +0000)
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6770 6f19259b-4bc3-4df7-8a09-765794883524

MdePkg/Include/Library/PciSegmentLib.h
MdePkg/Library/PeiPciSegmentLibPciCfg2/PciSegmentLib.c

index e65e9a3590865e9cb061c62ed9497a9d75991716..84f6a573dbdfc5111c3eb8ec4792c8e3ffcd1723 100644 (file)
@@ -117,7 +117,7 @@ PciSegmentRead8 (
   @param  Address     Address that encodes the PCI Segment, Bus, Device, Function, and Register.\r
   @param  Value       The value to write.\r
 \r
-  @return The parameter of Value.\r
+  @return The value written to the PCI configuration register.\r
 \r
 **/\r
 UINT8\r
@@ -205,22 +205,22 @@ PciSegmentAndThenOr8 (
 /**\r
   Reads a bit field of a PCI configuration register.\r
 \r
-  Reads the bit field in an 8-bit PCI configuration register.\r
-  The bit field is specified by the StartBit and the EndBit.\r
-  The value of the bit field is returned.\r
-  \r
+  Reads the bit field in an 8-bit PCI configuration register. The bit field is\r
+  specified by the StartBit and the EndBit. The value of the bit field is\r
+  returned.\r
+\r
   If any reserved bits in Address are set, then ASSERT().\r
   If StartBit is greater than 7, then ASSERT().\r
   If EndBit is greater than 7, then ASSERT().\r
   If EndBit is less than StartBit, then ASSERT().\r
 \r
-  @param  Address   Address that encodes the PCI Segment, Bus, Device, Function, and Register.\r
+  @param  Address   PCI configuration register to read.\r
   @param  StartBit  The ordinal of the least significant bit in the bit field.\r
-                    The ordinal of the least significant bit in a byte is bit 0.\r
+                    Range 0..7.\r
   @param  EndBit    The ordinal of the most significant bit in the bit field.\r
-                    The ordinal of the most significant bit in a byte is bit 7.\r
+                    Range 0..7.\r
 \r
-  @return The value of the bit field.\r
+  @return The value of the bit field read from the PCI configuration register.\r
 \r
 **/\r
 UINT8\r
@@ -234,23 +234,24 @@ PciSegmentBitFieldRead8 (
 /**\r
   Writes a bit field to a PCI configuration register.\r
 \r
-  Writes Value to the bit field of the PCI configuration register.\r
-  The bit field is specified by the StartBit and the EndBit.\r
-  All other bits in the destination PCI configuration register are preserved.\r
-  The new value of the 8-bit register is returned.\r
+  Writes Value to the bit field of the PCI configuration register. The bit\r
+  field is specified by the StartBit and the EndBit. All other bits in the\r
+  destination PCI configuration register are preserved. The new value of the\r
+  8-bit register is returned.\r
+\r
   If any reserved bits in Address are set, then ASSERT().\r
   If StartBit is greater than 7, then ASSERT().\r
   If EndBit is greater than 7, then ASSERT().\r
   If EndBit is less than StartBit, then ASSERT().\r
 \r
-  @param  Address   Address that encodes the PCI Segment, Bus, Device, Function, and Register.\r
+  @param  Address   PCI configuration register to write.\r
   @param  StartBit  The ordinal of the least significant bit in the bit field.\r
-                    The ordinal of the least significant bit in a byte is bit 0.\r
+                    Range 0..7.\r
   @param  EndBit    The ordinal of the most significant bit in the bit field.\r
-                    The ordinal of the most significant bit in a byte is bit 7.\r
+                    Range 0..7.\r
   @param  Value     New value of the bit field.\r
 \r
-  @return The new value of the 8-bit register.\r
+  @return The value written back to the PCI configuration register.\r
 \r
 **/\r
 UINT8\r
@@ -263,23 +264,29 @@ PciSegmentBitFieldWrite8 (
   );\r
 \r
 /**\r
-  Reads the 8-bit PCI configuration register specified by Address,\r
-  performs a bitwise inclusive OR between the read result and the value specified by OrData,\r
-  and writes the result to the 8-bit PCI configuration register specified by Address. \r
-  \r
+  Reads a bit field in an 8-bit PCI configuration, performs a bitwise OR, and\r
+  writes the result back to the bit field in the 8-bit port.\r
+\r
+  Reads the 8-bit PCI configuration register specified by Address, performs a\r
+  bitwise inclusive OR between the read result and the value specified by\r
+  OrData, and writes the result to the 8-bit PCI configuration register\r
+  specified by Address. The value written to the PCI configuration register is\r
+  returned. This function must guarantee that all PCI read and write operations\r
+  are serialized. Extra left bits in OrData are stripped.\r
+\r
   If any reserved bits in Address are set, then ASSERT().\r
   If StartBit is greater than 7, then ASSERT().\r
   If EndBit is greater than 7, then ASSERT().\r
   If EndBit is less than StartBit, then ASSERT().\r
 \r
-  @param  Address   Address that encodes the PCI Segment, Bus, Device, Function, and Register.\r
+  @param  Address   PCI configuration register to write.\r
   @param  StartBit  The ordinal of the least significant bit in the bit field.\r
-                    The ordinal of the least significant bit in a byte is bit 0.\r
+                    Range 0..7.\r
   @param  EndBit    The ordinal of the most significant bit in the bit field.\r
-                    The ordinal of the most significant bit in a byte is bit 7.\r
-  @param  OrData    The value to OR with the read value from the PCI configuration register.\r
+                    Range 0..7.\r
+  @param  OrData    The value to OR with the PCI configuration register.\r
 \r
-  @return The value written to the PCI configuration register.\r
+  @return The value written back to the PCI configuration register.\r
 \r
 **/\r
 UINT8\r
@@ -292,29 +299,29 @@ PciSegmentBitFieldOr8 (
   );\r
 \r
 /**\r
-  Reads a bit field in an 8-bit PCI configuration, performs a bitwise OR,\r
-  and writes the result back to the bit field in the 8-bit port.\r
+  Reads a bit field in an 8-bit PCI configuration register, performs a bitwise\r
+  AND, and writes the result back to the bit field in the 8-bit register.\r
+\r
+  Reads the 8-bit PCI configuration register specified by Address, performs a\r
+  bitwise AND between the read result and the value specified by AndData, and\r
+  writes the result to the 8-bit PCI configuration register specified by\r
+  Address. The value written to the PCI configuration register is returned.\r
+  This function must guarantee that all PCI read and write operations are\r
+  serialized. Extra left bits in AndData are stripped.\r
 \r
-  Reads the 8-bit PCI configuration register specified by Address,\r
-  performs a bitwise inclusive OR between the read result and the value specified by OrData,\r
-  and writes the result to the 8-bit PCI configuration register specified by Address.\r
-  The value written to the PCI configuration register is returned.\r
-  This function must guarantee that all PCI read and write operations are serialized.\r
-  Extra left bits in OrData are stripped.\r
-  \r
   If any reserved bits in Address are set, then ASSERT().\r
   If StartBit is greater than 7, then ASSERT().\r
   If EndBit is greater than 7, then ASSERT().\r
   If EndBit is less than StartBit, then ASSERT().\r
 \r
-  @param  Address   Address that encodes the PCI Segment, Bus, Device, Function, and Register.\r
+  @param  Address   PCI configuration register to write.\r
   @param  StartBit  The ordinal of the least significant bit in the bit field.\r
-                    The ordinal of the least significant bit in a byte is bit 0.\r
+                    Range 0..7.\r
   @param  EndBit    The ordinal of the most significant bit in the bit field.\r
-                    The ordinal of the most significant bit in a byte is bit 7.\r
-  @param  AndData   The value to AND with the read value from the PCI configuration register.\r
+                    Range 0..7.\r
+  @param  AndData   The value to AND with the PCI configuration register.\r
 \r
-  @return The value written to the PCI configuration register.\r
+  @return The value written back to the PCI configuration register.\r
 \r
 **/\r
 UINT8\r
@@ -327,30 +334,32 @@ PciSegmentBitFieldAnd8 (
   );\r
 \r
 /**\r
-  Reads a bit field in an 8-bit PCI configuration register, performs a bitwise AND,\r
-  and writes the result back to the bit field in the 8-bit register.\r
\r
-  Reads the 8-bit PCI configuration register specified by Address,\r
-  performs a bitwise AND between the read result and the value specified by AndData,\r
-  and writes the result to the 8-bit PCI configuration register specified by Address.\r
-  The value written to the PCI configuration register is returned.\r
-  This function must guarantee that all PCI read and write operations are serialized.\r
-  Extra left bits in AndData are stripped.\r
-  \r
+  Reads a bit field in an 8-bit port, performs a bitwise AND followed by a\r
+  bitwise inclusive OR, and writes the result back to the bit field in the\r
+  8-bit port.\r
+\r
+  Reads the 8-bit PCI configuration register specified by Address, performs a\r
+  bitwise AND followed by a bitwise inclusive OR between the read result and\r
+  the value specified by AndData, and writes the result to the 8-bit PCI\r
+  configuration register specified by Address. The value written to the PCI\r
+  configuration register is returned. This function must guarantee that all PCI\r
+  read and write operations are serialized. Extra left bits in both AndData and\r
+  OrData are stripped.\r
+\r
   If any reserved bits in Address are set, then ASSERT().\r
   If StartBit is greater than 7, then ASSERT().\r
   If EndBit is greater than 7, then ASSERT().\r
   If EndBit is less than StartBit, then ASSERT().\r
 \r
-  @param  Address   Address that encodes the PCI Segment, Bus, Device, Function, and Register.\r
+  @param  Address   PCI configuration register to write.\r
   @param  StartBit  The ordinal of the least significant bit in the bit field.\r
-                    The ordinal of the least significant bit in a byte is bit 0.\r
+                    Range 0..7.\r
   @param  EndBit    The ordinal of the most significant bit in the bit field.\r
-                    The ordinal of the most significant bit in a byte is bit 7.\r
-  @param  AndData   The value to AND with the read value from the PCI configuration register.\r
-  @param  OrData    The value to OR with the read value from the PCI configuration register.\r
+                    Range 0..7.\r
+  @param  AndData   The value to AND with the PCI configuration register.\r
+  @param  OrData    The value to OR with the result of the AND operation.\r
 \r
-  @return The value written to the PCI configuration register.\r
+  @return The value written back to the PCI configuration register.\r
 \r
 **/\r
 UINT8\r
@@ -406,21 +415,24 @@ PciSegmentWrite16 (
   );\r
 \r
 /**\r
-  Performs a bitwise inclusive OR of a 16-bit PCI configuration register with a 16-bit value.\r
+  Performs a bitwise inclusive OR of a 16-bit PCI configuration register with\r
+  a 16-bit value.\r
+\r
+  Reads the 16-bit PCI configuration register specified by Address, performs a\r
+  bitwise inclusive OR between the read result and the value specified by\r
+  OrData, and writes the result to the 16-bit PCI configuration register\r
+  specified by Address. The value written to the PCI configuration register is\r
+  returned. This function must guarantee that all PCI read and write operations\r
+  are serialized.\r
 \r
-  Reads the 16-bit PCI configuration register specified by Address,\r
-  performs a bitwise inclusive OR between the read result and the value specified by OrData,\r
-  and writes the result to the 16-bit PCI configuration register specified by Address.\r
-  The value written to the PCI configuration register is returned.\r
-  This function must guarantee that all PCI read and write operations are serialized.\r
-  \r
   If any reserved bits in Address are set, then ASSERT().\r
   If Address is not aligned on a 16-bit boundary, then ASSERT().\r
 \r
-  @param  Address   Address that encodes the PCI Segment, Bus, Device, Function, and Register.\r
-  @param  OrData    The value to OR with the PCI configuration register.\r
+  @param  Address Address that encodes the PCI Segment, Bus, Device, Function and\r
+                  Register.\r
+  @param  OrData  The value to OR with the PCI configuration register.\r
 \r
-  @return The value written to the PCI configuration register.\r
+  @return The value written back to the PCI configuration register.\r
 \r
 **/\r
 UINT16\r
@@ -487,23 +499,23 @@ PciSegmentAndThenOr16 (
 /**\r
   Reads a bit field of a PCI configuration register.\r
 \r
-  Reads the bit field in a 16-bit PCI configuration register.\r
-  The bit field is specified by the StartBit and the EndBit.\r
-  The value of the bit field is returned.\r
-  \r
+  Reads the bit field in a 16-bit PCI configuration register. The bit field is\r
+  specified by the StartBit and the EndBit. The value of the bit field is\r
+  returned.\r
+\r
   If any reserved bits in Address are set, then ASSERT().\r
   If Address is not aligned on a 16-bit boundary, then ASSERT().\r
-  If StartBit is greater than 7, then ASSERT().\r
-  If EndBit is greater than 7, then ASSERT().\r
+  If StartBit is greater than 15, then ASSERT().\r
+  If EndBit is greater than 15, then ASSERT().\r
   If EndBit is less than StartBit, then ASSERT().\r
 \r
-  @param  Address   Address that encodes the PCI Segment, Bus, Device, Function, and Register.\r
+  @param  Address   PCI configuration register to read.\r
   @param  StartBit  The ordinal of the least significant bit in the bit field.\r
-                    The ordinal of the least significant bit in a byte is bit 0.\r
+                    Range 0..15.\r
   @param  EndBit    The ordinal of the most significant bit in the bit field.\r
-                    The ordinal of the most significant bit in a byte is bit 7.\r
+                    Range 0..15.\r
 \r
-  @return The value of the bit field.\r
+  @return The value of the bit field read from the PCI configuration register.\r
 \r
 **/\r
 UINT16\r
@@ -517,25 +529,25 @@ PciSegmentBitFieldRead16 (
 /**\r
   Writes a bit field to a PCI configuration register.\r
 \r
-  Writes Value to the bit field of the PCI configuration register.\r
-  The bit field is specified by the StartBit and the EndBit.\r
-  All other bits in the destination PCI configuration register are preserved.\r
-  The new value of the 16-bit register is returned.\r
-  \r
+  Writes Value to the bit field of the PCI configuration register. The bit\r
+  field is specified by the StartBit and the EndBit. All other bits in the\r
+  destination PCI configuration register are preserved. The new value of the\r
+  16-bit register is returned.\r
+\r
   If any reserved bits in Address are set, then ASSERT().\r
   If Address is not aligned on a 16-bit boundary, then ASSERT().\r
-  If StartBit is greater than 7, then ASSERT().\r
-  If EndBit is greater than 7, then ASSERT().\r
+  If StartBit is greater than 15, then ASSERT().\r
+  If EndBit is greater than 15, then ASSERT().\r
   If EndBit is less than StartBit, then ASSERT().\r
 \r
-  @param  Address   Address that encodes the PCI Segment, Bus, Device, Function, and Register.\r
+  @param  Address   PCI configuration register to write.\r
   @param  StartBit  The ordinal of the least significant bit in the bit field.\r
-                    The ordinal of the least significant bit in a byte is bit 0.\r
+                    Range 0..15.\r
   @param  EndBit    The ordinal of the most significant bit in the bit field.\r
-                    The ordinal of the most significant bit in a byte is bit 7.\r
+                    Range 0..15.\r
   @param  Value     New value of the bit field.\r
 \r
-  @return The new value of the 16-bit register.\r
+  @return The value written back to the PCI configuration register.\r
 \r
 **/\r
 UINT16\r
@@ -558,14 +570,14 @@ PciSegmentBitFieldWrite16 (
   If EndBit is greater than 15, then ASSERT().\r
   If EndBit is less than StartBit, then ASSERT().\r
 \r
-  @param  Address   Address that encodes the PCI Segment, Bus, Device, Function, and Register.\r
+  @param  Address   PCI configuration register to write.\r
   @param  StartBit  The ordinal of the least significant bit in the bit field.\r
-                    The ordinal of the least significant bit in a byte is bit 0.\r
+                    Range 0..15.\r
   @param  EndBit    The ordinal of the most significant bit in the bit field.\r
-                    The ordinal of the most significant bit in a byte is bit 7.\r
-  @param  OrData    The value to OR with the read value from the PCI configuration register.\r
+                    Range 0..15.\r
+  @param  OrData    The value to OR with the PCI configuration register.\r
 \r
-  @return The value written to the PCI configuration register.\r
+  @return The value written back to the PCI configuration register.\r
 \r
 **/\r
 UINT16\r
@@ -614,31 +626,32 @@ PciSegmentBitFieldAnd16 (
   );\r
 \r
 /**\r
-  Reads a bit field in a 16-bit PCI configuration register, performs a bitwise AND,\r
-  and writes the result back to the bit field in the 16-bit register.\r
\r
-  Reads the 16-bit PCI configuration register specified by Address,\r
-  performs a bitwise AND between the read result and the value specified by AndData,\r
-  and writes the result to the 16-bit PCI configuration register specified by Address.\r
-  The value written to the PCI configuration register is returned.\r
-  This function must guarantee that all PCI read and write operations are serialized.\r
-  Extra left bits in AndData are stripped.\r
-  \r
+  Reads a bit field in a 16-bit port, performs a bitwise AND followed by a\r
+  bitwise inclusive OR, and writes the result back to the bit field in the\r
+  16-bit port.\r
+\r
+  Reads the 16-bit PCI configuration register specified by Address, performs a\r
+  bitwise AND followed by a bitwise inclusive OR between the read result and\r
+  the value specified by AndData, and writes the result to the 16-bit PCI\r
+  configuration register specified by Address. The value written to the PCI\r
+  configuration register is returned. This function must guarantee that all PCI\r
+  read and write operations are serialized. Extra left bits in both AndData and\r
+  OrData are stripped.\r
+\r
   If any reserved bits in Address are set, then ASSERT().\r
-  If Address is not aligned on a 16-bit boundary, then ASSERT()..\r
-  If StartBit is greater than 7, then ASSERT().\r
-  If EndBit is greater than 7, then ASSERT().\r
+  If StartBit is greater than 15, then ASSERT().\r
+  If EndBit is greater than 15, then ASSERT().\r
   If EndBit is less than StartBit, then ASSERT().\r
 \r
-  @param  Address   Address that encodes the PCI Segment, Bus, Device, Function, and Register.\r
+  @param  Address   PCI configuration register to write.\r
   @param  StartBit  The ordinal of the least significant bit in the bit field.\r
-                    The ordinal of the least significant bit in a byte is bit 0.\r
+                    Range 0..15.\r
   @param  EndBit    The ordinal of the most significant bit in the bit field.\r
-                    The ordinal of the most significant bit in a byte is bit 7.\r
-  @param  AndData   The value to AND with the read value from the PCI configuration register.\r
-  @param  OrData    The value to OR with the read value from the PCI configuration register.\r
+                    Range 0..15.\r
+  @param  AndData   The value to AND with the PCI configuration register.\r
+  @param  OrData    The value to OR with the result of the AND operation.\r
 \r
-  @return The value written to the PCI configuration register.\r
+  @return The value written back to the PCI configuration register.\r
 \r
 **/\r
 UINT16\r
@@ -775,23 +788,23 @@ PciSegmentAndThenOr32 (
 /**\r
   Reads a bit field of a PCI configuration register.\r
 \r
-  Reads the bit field in a 32-bit PCI configuration register.\r
-  The bit field is specified by the StartBit and the EndBit.\r
-  The value of the bit field is returned.\r
-  \r
+  Reads the bit field in a 32-bit PCI configuration register. The bit field is\r
+  specified by the StartBit and the EndBit. The value of the bit field is\r
+  returned.\r
+\r
   If any reserved bits in Address are set, then ASSERT().\r
   If Address is not aligned on a 32-bit boundary, then ASSERT().\r
-  If StartBit is greater than 7, then ASSERT().\r
-  If EndBit is greater than 7, then ASSERT().\r
+  If StartBit is greater than 31, then ASSERT().\r
+  If EndBit is greater than 31, then ASSERT().\r
   If EndBit is less than StartBit, then ASSERT().\r
 \r
-  @param  Address   Address that encodes the PCI Segment, Bus, Device, Function, and Register.\r
+  @param  Address   PCI configuration register to read.\r
   @param  StartBit  The ordinal of the least significant bit in the bit field.\r
-                    The ordinal of the least significant bit in a byte is bit 0.\r
+                    Range 0..31.\r
   @param  EndBit    The ordinal of the most significant bit in the bit field.\r
-                    The ordinal of the most significant bit in a byte is bit 7.\r
+                    Range 0..31.\r
 \r
-  @return The value of the bit field.\r
+  @return The value of the bit field read from the PCI configuration register.\r
 \r
 **/\r
 UINT32\r
@@ -805,25 +818,25 @@ PciSegmentBitFieldRead32 (
 /**\r
   Writes a bit field to a PCI configuration register.\r
 \r
-  Writes Value to the bit field of the PCI configuration register.\r
-  The bit field is specified by the StartBit and the EndBit.\r
-  All other bits in the destination PCI configuration register are preserved.\r
-  The new value of the 32-bit register is returned.\r
-  \r
+  Writes Value to the bit field of the PCI configuration register. The bit\r
+  field is specified by the StartBit and the EndBit. All other bits in the\r
+  destination PCI configuration register are preserved. The new value of the\r
+  32-bit register is returned.\r
+\r
   If any reserved bits in Address are set, then ASSERT().\r
   If Address is not aligned on a 32-bit boundary, then ASSERT().\r
-  If StartBit is greater than 7, then ASSERT().\r
-  If EndBit is greater than 7, then ASSERT().\r
+  If StartBit is greater than 31, then ASSERT().\r
+  If EndBit is greater than 31, then ASSERT().\r
   If EndBit is less than StartBit, then ASSERT().\r
 \r
-  @param  Address   Address that encodes the PCI Segment, Bus, Device, Function, and Register.\r
+  @param  Address   PCI configuration register to write.\r
   @param  StartBit  The ordinal of the least significant bit in the bit field.\r
-                    The ordinal of the least significant bit in a byte is bit 0.\r
+                    Range 0..31.\r
   @param  EndBit    The ordinal of the most significant bit in the bit field.\r
-                    The ordinal of the most significant bit in a byte is bit 7.\r
+                    Range 0..31.\r
   @param  Value     New value of the bit field.\r
 \r
-  @return The new value of the 32-bit register.\r
+  @return The value written back to the PCI configuration register.\r
 \r
 **/\r
 UINT32\r
@@ -836,24 +849,29 @@ PciSegmentBitFieldWrite32 (
   );\r
 \r
 /**\r
-  Reads the 32-bit PCI configuration register specified by Address,\r
-  performs a bitwise inclusive OR between the read result and the value specified by OrData,\r
-  and writes the result to the 32-bit PCI configuration register specified by Address. \r
-  \r
+  Reads a bit field in a 32-bit PCI configuration, performs a bitwise OR, and\r
+  writes the result back to the bit field in the 32-bit port.\r
+\r
+  Reads the 32-bit PCI configuration register specified by Address, performs a\r
+  bitwise inclusive OR between the read result and the value specified by\r
+  OrData, and writes the result to the 32-bit PCI configuration register\r
+  specified by Address. The value written to the PCI configuration register is\r
+  returned. This function must guarantee that all PCI read and write operations\r
+  are serialized. Extra left bits in OrData are stripped.\r
+\r
   If any reserved bits in Address are set, then ASSERT().\r
-  If Address is not aligned on a 32-bit boundary, then ASSERT().\r
-  If StartBit is greater than 7, then ASSERT().\r
-  If EndBit is greater than 7, then ASSERT().\r
+  If StartBit is greater than 31, then ASSERT().\r
+  If EndBit is greater than 31, then ASSERT().\r
   If EndBit is less than StartBit, then ASSERT().\r
-  \r
-  @param  Address   Address that encodes the PCI Segment, Bus, Device, Function, and Register.\r
+\r
+  @param  Address   PCI configuration register to write.\r
   @param  StartBit  The ordinal of the least significant bit in the bit field.\r
-                    The ordinal of the least significant bit in a byte is bit 0.\r
+                    Range 0..31.\r
   @param  EndBit    The ordinal of the most significant bit in the bit field.\r
-                    The ordinal of the most significant bit in a byte is bit 7.\r
-  @param  OrData    The value to OR with the read value from the PCI configuration register.\r
+                    Range 0..31.\r
+  @param  OrData    The value to OR with the PCI configuration register.\r
 \r
-  @return The value written to the PCI configuration register.\r
+  @return The value written back to the PCI configuration register.\r
 \r
 **/\r
 UINT32\r
@@ -866,30 +884,30 @@ PciSegmentBitFieldOr32 (
   );\r
 \r
 /**\r
-  Reads a bit field in a 32-bit PCI configuration, performs a bitwise OR,\r
-  and writes the result back to the bit field in the 32-bit port.\r
+  Reads a bit field in a 32-bit PCI configuration register, performs a bitwise\r
+  AND, and writes the result back to the bit field in the 32-bit register.\r
 \r
-  Reads the 32-bit PCI configuration register specified by Address,\r
-  performs a bitwise inclusive OR between the read result and the value specified by OrData,\r
-  and writes the result to the 32-bit PCI configuration register specified by Address.\r
-  The value written to the PCI configuration register is returned.\r
-  This function must guarantee that all PCI read and write operations are serialized.\r
-  Extra left bits in OrData are stripped.\r
   \r
+  Reads the 32-bit PCI configuration register specified by Address, performs a bitwise\r
+  AND between the read result and the value specified by AndData, and writes the result\r
+  to the 32-bit PCI configuration register specified by Address. The value written to\r
+  the PCI configuration register is returned.  This function must guarantee that all PCI\r
+  read and write operations are serialized.  Extra left bits in AndData are stripped.\r
   If any reserved bits in Address are set, then ASSERT().\r
   If Address is not aligned on a 32-bit boundary, then ASSERT().\r
-  If StartBit is greater than 7, then ASSERT().\r
-  If EndBit is greater than 7, then ASSERT().\r
+  If StartBit is greater than 31, then ASSERT().\r
+  If EndBit is greater than 31, then ASSERT().\r
   If EndBit is less than StartBit, then ASSERT().\r
+  \r
 \r
-  @param  Address   Address that encodes the PCI Segment, Bus, Device, Function, and Register.\r
+  @param  Address   PCI configuration register to write.\r
   @param  StartBit  The ordinal of the least significant bit in the bit field.\r
-                    The ordinal of the least significant bit in a byte is bit 0.\r
+                    Range 0..31.\r
   @param  EndBit    The ordinal of the most significant bit in the bit field.\r
-                    The ordinal of the most significant bit in a byte is bit 7.\r
-  @param  AndData   The value to AND with the read value from the PCI configuration register.\r
+                    Range 0..31.\r
+  @param  AndData   The value to AND with the PCI configuration register.\r
 \r
-  @return The value written to the PCI configuration register.\r
+  @return The value written back to the PCI configuration register.\r
 \r
 **/\r
 UINT32\r
@@ -902,31 +920,32 @@ PciSegmentBitFieldAnd32 (
   );\r
 \r
 /**\r
-  Reads a bit field in a 32-bit PCI configuration register, performs a bitwise AND,\r
-  and writes the result back to the bit field in the 32-bit register.\r
\r
-  Reads the 32-bit PCI configuration register specified by Address,\r
-  performs a bitwise AND between the read result and the value specified by AndData,\r
-  and writes the result to the 32-bit PCI configuration register specified by Address.\r
-  The value written to the PCI configuration register is returned.\r
-  This function must guarantee that all PCI read and write operations are serialized.\r
-  Extra left bits in AndData are stripped.\r
-  \r
+  Reads a bit field in a 32-bit port, performs a bitwise AND followed by a\r
+  bitwise inclusive OR, and writes the result back to the bit field in the\r
+  32-bit port.\r
+\r
+  Reads the 32-bit PCI configuration register specified by Address, performs a\r
+  bitwise AND followed by a bitwise inclusive OR between the read result and\r
+  the value specified by AndData, and writes the result to the 32-bit PCI\r
+  configuration register specified by Address. The value written to the PCI\r
+  configuration register is returned. This function must guarantee that all PCI\r
+  read and write operations are serialized. Extra left bits in both AndData and\r
+  OrData are stripped.\r
+\r
   If any reserved bits in Address are set, then ASSERT().\r
-  If Address is not aligned on a 32-bit boundary, then ASSERT().\r
-  If StartBit is greater than 7, then ASSERT().\r
-  If EndBit is greater than 7, then ASSERT().\r
+  If StartBit is greater than 31, then ASSERT().\r
+  If EndBit is greater than 31, then ASSERT().\r
   If EndBit is less than StartBit, then ASSERT().\r
 \r
-  @param  Address   Address that encodes the PCI Segment, Bus, Device, Function, and Register.\r
+  @param  Address   PCI configuration register to write.\r
   @param  StartBit  The ordinal of the least significant bit in the bit field.\r
-                    The ordinal of the least significant bit in a byte is bit 0.\r
+                    Range 0..31.\r
   @param  EndBit    The ordinal of the most significant bit in the bit field.\r
-                    The ordinal of the most significant bit in a byte is bit 7.\r
-  @param  AndData   The value to AND with the read value from the PCI configuration register.\r
-  @param  OrData    The value to OR with the read value from the PCI configuration register.\r
+                    Range 0..31.\r
+  @param  AndData   The value to AND with the PCI configuration register.\r
+  @param  OrData    The value to OR with the result of the AND operation.\r
 \r
-  @return The value written to the PCI configuration register.\r
+  @return The value written back to the PCI configuration register.\r
 \r
 **/\r
 UINT32\r
@@ -942,21 +961,24 @@ PciSegmentBitFieldAndThenOr32 (
 /**\r
   Reads a range of PCI configuration registers into a caller supplied buffer.\r
 \r
-  Reads the range of PCI configuration registers specified by StartAddress\r
-  and Size into the buffer specified by Buffer.\r
-  This function only allows the PCI configuration registers from a single PCI function to be read.\r
-  Size is returned.\r
-  \r
-  If any reserved bits in StartAddress are set, then ASSERT().\r
+  Reads the range of PCI configuration registers specified by StartAddress and\r
+  Size into the buffer specified by Buffer. This function only allows the PCI\r
+  configuration registers from a single PCI function to be read. Size is\r
+  returned. When possible 32-bit PCI configuration read cycles are used to read\r
+  from StartAdress to StartAddress + Size. Due to alignment restrictions, 8-bit\r
+  and 16-bit PCI configuration read cycles may be used at the beginning and the\r
+  end of the range.\r
+\r
+  If StartAddress > 0x0FFFFFFF, then ASSERT().\r
   If ((StartAddress & 0xFFF) + Size) > 0x1000, then ASSERT().\r
-  If (StartAddress + Size - 1)  > 0x0FFFFFFF, then ASSERT().\r
   If Size > 0 and Buffer is NULL, then ASSERT().\r
 \r
-  @param  StartAddress  Starting address that encodes the PCI Segment, Bus, Device, Function, and Register.\r
+  @param  StartAddress  Starting address that encodes the PCI Segment, Bus, Device,\r
+                        Function and Register.\r
   @param  Size          Size in bytes of the transfer.\r
   @param  Buffer        Pointer to a buffer receiving the data read.\r
 \r
-  @return The parameter of Size.\r
+  @return Size\r
 \r
 **/\r
 UINTN\r
@@ -968,19 +990,23 @@ PciSegmentReadBuffer (
   );\r
 \r
 /**\r
-  Copies the data in a caller supplied buffer to a specified range of PCI configuration space.\r
-\r
-  Writes the range of PCI configuration registers specified by StartAddress\r
-  and Size from the buffer specified by Buffer.\r
-  This function only allows the PCI configuration registers from a single PCI function to be written.\r
-  Size is returned.\r
-  \r
-  If any reserved bits in StartAddress are set, then ASSERT().\r
+  Copies the data in a caller supplied buffer to a specified range of PCI\r
+  configuration space.\r
+\r
+  Writes the range of PCI configuration registers specified by StartAddress and\r
+  Size from the buffer specified by Buffer. This function only allows the PCI\r
+  configuration registers from a single PCI function to be written. Size is\r
+  returned. When possible 32-bit PCI configuration write cycles are used to\r
+  write from StartAdress to StartAddress + Size. Due to alignment restrictions,\r
+  8-bit and 16-bit PCI configuration write cycles may be used at the beginning\r
+  and the end of the range.\r
+\r
+  If StartAddress > 0x0FFFFFFF, then ASSERT().\r
   If ((StartAddress & 0xFFF) + Size) > 0x1000, then ASSERT().\r
-  If (StartAddress + Size - 1)  > 0x0FFFFFFF, then ASSERT().\r
-  If Buffer is NULL, then ASSERT().\r
+  If Size > 0 and Buffer is NULL, then ASSERT().\r
 \r
-  @param  StartAddress  Starting address that encodes the PCI Segment, Bus, Device, Function, and Register.\r
+  @param  StartAddress  Starting address that encodes the PCI Segment, Bus, Device,\r
+                        Function and Register.\r
   @param  Size          Size in bytes of the transfer.\r
   @param  Buffer        Pointer to a buffer containing the data to write.\r
 \r
index a02954ae0564fddbb4671d07a15e14e0a3a4e68e..c2f2ebbc9ed6762e768f762c25026e7b3498e630 100644 (file)
@@ -192,15 +192,13 @@ PciSegmentRegisterForRuntimeAccess (
   Reads an 8-bit PCI configuration register.\r
 \r
   Reads and returns the 8-bit PCI configuration register specified by Address.\r
-  This function must guarantee that all PCI read and write operations are\r
-  serialized.\r
-\r
+  This function must guarantee that all PCI read and write operations are serialized.\r
+  \r
   If any reserved bits in Address are set, then ASSERT().\r
+  \r
+  @param  Address   Address that encodes the PCI Segment, Bus, Device, Function, and Register.\r
 \r
-  @param  Address Address that encodes the PCI Segment, Bus, Device, Function and\r
-                  Register.\r
-\r
-  @return The value read from the PCI configuration register.\r
+  @return The 8-bit PCI configuration register specified by Address.\r
 \r
 **/\r
 UINT8\r
@@ -217,15 +215,13 @@ PciSegmentRead8 (
 /**\r
   Writes an 8-bit PCI configuration register.\r
 \r
-  Writes the 8-bit PCI configuration register specified by Address with the\r
-  value specified by Value. Value is returned. This function must guarantee\r
-  that all PCI read and write operations are serialized.\r
-\r
-  If any reserved bits in Address are set, then ASSERT().\r
+  Writes the 8-bit PCI configuration register specified by Address with the value specified by Value.\r
+  Value is returned.  This function must guarantee that all PCI read and write operations are serialized.\r
+  \r
+  If Address > 0x0FFFFFFF, then ASSERT().\r
 \r
-  @param  Address Address that encodes the PCI Segment, Bus, Device, Function and\r
-                  Register.\r
-  @param  Data    The value to write.\r
+  @param  Address     Address that encodes the PCI Segment, Bus, Device, Function, and Register.\r
+  @param  Value       The value to write.\r
 \r
   @return The value written to the PCI configuration register.\r
 \r
@@ -234,32 +230,29 @@ UINT8
 EFIAPI\r
 PciSegmentWrite8 (\r
   IN      UINT64                    Address,\r
-  IN      UINT8                     Data\r
+  IN      UINT8                     Value\r
   )\r
 {\r
   ASSERT_INVALID_PCI_SEGMENT_ADDRESS (Address, 0);\r
 \r
-  return (UINT8) PeiPciSegmentLibPciCfg2WriteWorker (Address, EfiPeiPciCfgWidthUint8, Data);\r
+  return (UINT8) PeiPciSegmentLibPciCfg2WriteWorker (Address, EfiPeiPciCfgWidthUint8, Value);\r
 }\r
 \r
 /**\r
-  Performs a bitwise inclusive OR of an 8-bit PCI configuration register with\r
-  an 8-bit value.\r
-\r
-  Reads the 8-bit PCI configuration register specified by Address, performs a\r
-  bitwise inclusive OR between the read result and the value specified by\r
-  OrData, and writes the result to the 8-bit PCI configuration register\r
-  specified by Address. The value written to the PCI configuration register is\r
-  returned. This function must guarantee that all PCI read and write operations\r
-  are serialized.\r
+  Performs a bitwise inclusive OR of an 8-bit PCI configuration register with an 8-bit value.\r
 \r
+  Reads the 8-bit PCI configuration register specified by Address,\r
+  performs a bitwise inclusive OR between the read result and the value specified by OrData,\r
+  and writes the result to the 8-bit PCI configuration register specified by Address.\r
+  The value written to the PCI configuration register is returned.\r
+  This function must guarantee that all PCI read and write operations are serialized.\r
+  \r
   If any reserved bits in Address are set, then ASSERT().\r
 \r
-  @param  Address Address that encodes the PCI Segment, Bus, Device, Function and\r
-                  Register.\r
-  @param  OrData  The value to OR with the PCI configuration register.\r
+  @param  Address   Address that encodes the PCI Segment, Bus, Device, Function, and Register.\r
+  @param  OrData    The value to OR with the PCI configuration register.\r
 \r
-  @return The value written back to the PCI configuration register.\r
+  @return The value written to the PCI configuration register.\r
 \r
 **/\r
 UINT8\r
@@ -530,15 +523,14 @@ PciSegmentBitFieldAndThenOr8 (
   Reads a 16-bit PCI configuration register.\r
 \r
   Reads and returns the 16-bit PCI configuration register specified by Address.\r
-  This function must guarantee that all PCI read and write operations are\r
-  serialized.\r
-\r
+  This function must guarantee that all PCI read and write operations are serialized.\r
+  \r
   If any reserved bits in Address are set, then ASSERT().\r
+  If Address is not aligned on a 16-bit boundary, then ASSERT().\r
+  \r
+  @param  Address   Address that encodes the PCI Segment, Bus, Device, Function, and Register.\r
 \r
-  @param  Address Address that encodes the PCI Segment, Bus, Device, Function and\r
-                  Register.\r
-\r
-  @return The value read from the PCI configuration register.\r
+  @return The 16-bit PCI configuration register specified by Address.\r
 \r
 **/\r
 UINT16\r
@@ -555,29 +547,28 @@ PciSegmentRead16 (
 /**\r
   Writes a 16-bit PCI configuration register.\r
 \r
-  Writes the 16-bit PCI configuration register specified by Address with the\r
-  value specified by Value. Value is returned. This function must guarantee\r
-  that all PCI read and write operations are serialized.\r
-\r
+  Writes the 16-bit PCI configuration register specified by Address with the value specified by Value.\r
+  Value is returned.  This function must guarantee that all PCI read and write operations are serialized.\r
+  \r
   If any reserved bits in Address are set, then ASSERT().\r
+  If Address is not aligned on a 16-bit boundary, then ASSERT().\r
 \r
-  @param  Address Address that encodes the PCI Segment, Bus, Device, Function and\r
-                  Register.\r
-  @param  Data    The value to write.\r
+  @param  Address     Address that encodes the PCI Segment, Bus, Device, Function, and Register.\r
+  @param  Value       The value to write.\r
 \r
-  @return The value written to the PCI configuration register.\r
+  @return The parameter of Value.\r
 \r
 **/\r
 UINT16\r
 EFIAPI\r
 PciSegmentWrite16 (\r
   IN      UINT64                    Address,\r
-  IN      UINT16                    Data\r
+  IN      UINT16                    Value\r
   )\r
 {\r
   ASSERT_INVALID_PCI_SEGMENT_ADDRESS (Address, 1);\r
 \r
-  return (UINT16) PeiPciSegmentLibPciCfg2WriteWorker (Address, EfiPeiPciCfgWidthUint16, Data);\r
+  return (UINT16) PeiPciSegmentLibPciCfg2WriteWorker (Address, EfiPeiPciCfgWidthUint16, Value);\r
 }\r
 \r
 /**\r
@@ -592,6 +583,7 @@ PciSegmentWrite16 (
   are serialized.\r
 \r
   If any reserved bits in Address are set, then ASSERT().\r
+  If Address is not aligned on a 16-bit boundary, then ASSERT().\r
 \r
   @param  Address Address that encodes the PCI Segment, Bus, Device, Function and\r
                   Register.\r
@@ -639,25 +631,24 @@ PciSegmentAnd16 (
 }\r
 \r
 /**\r
-  Performs a bitwise AND of a 16-bit PCI configuration register with a 16-bit\r
-  value, followed a  bitwise inclusive OR with another 16-bit value.\r
-\r
-  Reads the 16-bit PCI configuration register specified by Address, performs a\r
-  bitwise AND between the read result and the value specified by AndData,\r
-  performs a bitwise inclusive OR between the result of the AND operation and\r
-  the value specified by OrData, and writes the result to the 16-bit PCI\r
-  configuration register specified by Address. The value written to the PCI\r
-  configuration register is returned. This function must guarantee that all PCI\r
-  read and write operations are serialized.\r
-\r
+  Performs a bitwise AND of a 16-bit PCI configuration register with a 16-bit value,\r
+  followed a  bitwise inclusive OR with another 16-bit value.\r
+  \r
+  Reads the 16-bit PCI configuration register specified by Address,\r
+  performs a bitwise AND between the read result and the value specified by AndData,\r
+  performs a bitwise inclusive OR between the result of the AND operation and the value specified by OrData,\r
+  and writes the result to the 16-bit PCI configuration register specified by Address.\r
+  The value written to the PCI configuration register is returned.\r
+  This function must guarantee that all PCI read and write operations are serialized.\r
+  \r
   If any reserved bits in Address are set, then ASSERT().\r
+  If Address is not aligned on a 16-bit boundary, then ASSERT().\r
 \r
-  @param  Address Address that encodes the PCI Segment, Bus, Device, Function and\r
-                  Register.\r
-  @param  AndData The value to AND with the PCI configuration register.\r
-  @param  OrData  The value to OR with the result of the AND operation.\r
+  @param  Address   Address that encodes the PCI Segment, Bus, Device, Function, and Register.\r
+  @param  AndData    The value to AND with the PCI configuration register.\r
+  @param  OrData    The value to OR with the PCI configuration register.\r
 \r
-  @return The value written back to the PCI configuration register.\r
+  @return The value written to the PCI configuration register.\r
 \r
 **/\r
 UINT16\r
@@ -679,6 +670,7 @@ PciSegmentAndThenOr16 (
   returned.\r
 \r
   If any reserved bits in Address are set, then ASSERT().\r
+  If Address is not aligned on a 16-bit boundary, then ASSERT().\r
   If StartBit is greater than 15, then ASSERT().\r
   If EndBit is greater than 15, then ASSERT().\r
   If EndBit is less than StartBit, then ASSERT().\r
@@ -712,6 +704,7 @@ PciSegmentBitFieldRead16 (
   16-bit register is returned.\r
 \r
   If any reserved bits in Address are set, then ASSERT().\r
+  If Address is not aligned on a 16-bit boundary, then ASSERT().\r
   If StartBit is greater than 15, then ASSERT().\r
   If EndBit is greater than 15, then ASSERT().\r
   If EndBit is less than StartBit, then ASSERT().\r
@@ -742,17 +735,12 @@ PciSegmentBitFieldWrite16 (
 }\r
 \r
 /**\r
-  Reads a bit field in a 16-bit PCI configuration, performs a bitwise OR, and\r
-  writes the result back to the bit field in the 16-bit port.\r
-\r
-  Reads the 16-bit PCI configuration register specified by Address, performs a\r
-  bitwise inclusive OR between the read result and the value specified by\r
-  OrData, and writes the result to the 16-bit PCI configuration register\r
-  specified by Address. The value written to the PCI configuration register is\r
-  returned. This function must guarantee that all PCI read and write operations\r
-  are serialized. Extra left bits in OrData are stripped.\r
+  Reads the 16-bit PCI configuration register specified by Address,\r
+  performs a bitwise inclusive OR between the read result and the value specified by OrData,\r
+  and writes the result to the 16-bit PCI configuration register specified by Address. \r
 \r
   If any reserved bits in Address are set, then ASSERT().\r
+  If Address is not aligned on a 16-bit boundary, then ASSERT().\r
   If StartBit is greater than 15, then ASSERT().\r
   If EndBit is greater than 15, then ASSERT().\r
   If EndBit is less than StartBit, then ASSERT().\r
@@ -872,15 +860,14 @@ PciSegmentBitFieldAndThenOr16 (
   Reads a 32-bit PCI configuration register.\r
 \r
   Reads and returns the 32-bit PCI configuration register specified by Address.\r
-  This function must guarantee that all PCI read and write operations are\r
-  serialized.\r
-\r
+  This function must guarantee that all PCI read and write operations are serialized.\r
+  \r
   If any reserved bits in Address are set, then ASSERT().\r
+  If Address is not aligned on a 32-bit boundary, then ASSERT().\r
 \r
-  @param  Address Address that encodes the PCI Segment, Bus, Device, Function and\r
-                  Register.\r
+  @param  Address   Address that encodes the PCI Segment, Bus, Device, Function, and Register.\r
 \r
-  @return The value read from the PCI configuration register.\r
+  @return The 32-bit PCI configuration register specified by Address.\r
 \r
 **/\r
 UINT32\r
@@ -897,49 +884,46 @@ PciSegmentRead32 (
 /**\r
   Writes a 32-bit PCI configuration register.\r
 \r
-  Writes the 32-bit PCI configuration register specified by Address with the\r
-  value specified by Value. Value is returned. This function must guarantee\r
-  that all PCI read and write operations are serialized.\r
-\r
+  Writes the 32-bit PCI configuration register specified by Address with the value specified by Value.\r
+  Value is returned.  This function must guarantee that all PCI read and write operations are serialized.\r
+  \r
   If any reserved bits in Address are set, then ASSERT().\r
+  If Address is not aligned on a 32-bit boundary, then ASSERT().\r
 \r
-  @param  Address Address that encodes the PCI Segment, Bus, Device, Function and\r
-                  Register.\r
-  @param  Data    The value to write.\r
+  @param  Address     Address that encodes the PCI Segment, Bus, Device, Function, and Register.\r
+  @param  Value       The value to write.\r
 \r
-  @return The value written to the PCI configuration register.\r
+  @return The parameter of Value.\r
 \r
 **/\r
 UINT32\r
 EFIAPI\r
 PciSegmentWrite32 (\r
   IN      UINT64                    Address,\r
-  IN      UINT32                    Data\r
+  IN      UINT32                    Value\r
   )\r
 {\r
   ASSERT_INVALID_PCI_SEGMENT_ADDRESS (Address, 3);\r
 \r
-  return PeiPciSegmentLibPciCfg2WriteWorker (Address, EfiPeiPciCfgWidthUint32, Data);\r
+  return PeiPciSegmentLibPciCfg2WriteWorker (Address, EfiPeiPciCfgWidthUint32, Value);\r
 }\r
 \r
 /**\r
-  Performs a bitwise inclusive OR of a 32-bit PCI configuration register with\r
-  a 32-bit value.\r
-\r
-  Reads the 32-bit PCI configuration register specified by Address, performs a\r
-  bitwise inclusive OR between the read result and the value specified by\r
-  OrData, and writes the result to the 32-bit PCI configuration register\r
-  specified by Address. The value written to the PCI configuration register is\r
-  returned. This function must guarantee that all PCI read and write operations\r
-  are serialized.\r
+  Performs a bitwise inclusive OR of a 32-bit PCI configuration register with a 32-bit value.\r
 \r
+  Reads the 32-bit PCI configuration register specified by Address,\r
+  performs a bitwise inclusive OR between the read result and the value specified by OrData,\r
+  and writes the result to the 32-bit PCI configuration register specified by Address.\r
+  The value written to the PCI configuration register is returned.\r
+  This function must guarantee that all PCI read and write operations are serialized.\r
+  \r
   If any reserved bits in Address are set, then ASSERT().\r
+  If Address is not aligned on a 32-bit boundary, then ASSERT().\r
 \r
-  @param  Address Address that encodes the PCI Segment, Bus, Device, Function and\r
-                  Register.\r
-  @param  OrData  The value to OR with the PCI configuration register.\r
+  @param  Address   Address that encodes the PCI Segment, Bus, Device, Function, and Register.\r
+  @param  OrData    The value to OR with the PCI configuration register.\r
 \r
-  @return The value written back to the PCI configuration register.\r
+  @return The value written to the PCI configuration register.\r
 \r
 **/\r
 UINT32\r
@@ -1020,6 +1004,7 @@ PciSegmentAndThenOr32 (
   returned.\r
 \r
   If any reserved bits in Address are set, then ASSERT().\r
+  If Address is not aligned on a 32-bit boundary, then ASSERT().\r
   If StartBit is greater than 31, then ASSERT().\r
   If EndBit is greater than 31, then ASSERT().\r
   If EndBit is less than StartBit, then ASSERT().\r
@@ -1053,6 +1038,7 @@ PciSegmentBitFieldRead32 (
   32-bit register is returned.\r
 \r
   If any reserved bits in Address are set, then ASSERT().\r
+  If Address is not aligned on a 32-bit boundary, then ASSERT().\r
   If StartBit is greater than 31, then ASSERT().\r
   If EndBit is greater than 31, then ASSERT().\r
   If EndBit is less than StartBit, then ASSERT().\r
@@ -1306,6 +1292,7 @@ PciSegmentReadBuffer (
   return ReturnValue;\r
 }\r
 \r
+\r
 /**\r
   Copies the data in a caller supplied buffer to a specified range of PCI\r
   configuration space.\r
@@ -1327,7 +1314,7 @@ PciSegmentReadBuffer (
   @param  Size          Size in bytes of the transfer.\r
   @param  Buffer        Pointer to a buffer containing the data to write.\r
 \r
-  @return Size\r
+  @return The parameter of Size.\r
 \r
 **/\r
 UINTN\r