summaryrefslogtreecommitdiffstats
path: root/MdePkg/Library/PeiIoLibCpuIo
diff options
context:
space:
mode:
authorklu2 <klu2@6f19259b-4bc3-4df7-8a09-765794883524>2008-12-10 01:39:34 +0000
committerklu2 <klu2@6f19259b-4bc3-4df7-8a09-765794883524>2008-12-10 01:39:34 +0000
commit80f0c0c44f0a414efc2a0e5a0ff59ca998d595a3 (patch)
tree01d66ac4fda9ecba882848c663a78b1634c7bb7e /MdePkg/Library/PeiIoLibCpuIo
parent27a57d47352665aa68fb6e3f7e0143156261b8f8 (diff)
downloadedk2-80f0c0c44f0a414efc2a0e5a0ff59ca998d595a3.tar.gz
edk2-80f0c0c44f0a414efc2a0e5a0ff59ca998d595a3.tar.bz2
edk2-80f0c0c44f0a414efc2a0e5a0ff59ca998d595a3.zip
Synchronize function comments from library class to library instance.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6938 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdePkg/Library/PeiIoLibCpuIo')
-rw-r--r--MdePkg/Library/PeiIoLibCpuIo/IoHighLevel.c63
-rw-r--r--MdePkg/Library/PeiIoLibCpuIo/IoLib.c42
-rw-r--r--MdePkg/Library/PeiIoLibCpuIo/IoLibMmioBuffer.c32
3 files changed, 94 insertions, 43 deletions
diff --git a/MdePkg/Library/PeiIoLibCpuIo/IoHighLevel.c b/MdePkg/Library/PeiIoLibCpuIo/IoHighLevel.c
index 6fb5ca6e4e..1e5af51750 100644
--- a/MdePkg/Library/PeiIoLibCpuIo/IoHighLevel.c
+++ b/MdePkg/Library/PeiIoLibCpuIo/IoHighLevel.c
@@ -127,7 +127,7 @@ IoAndThenOr8 (
@param EndBit The ordinal of the most significant bit in the bit field.
Range 0..7.
- @return The value read from Port.
+ @return The value read.
**/
UINT8
@@ -313,6 +313,7 @@ IoBitFieldAndThenOr8 (
operations are serialized.
If 16-bit I/O port operations are not supported, then ASSERT().
+ If Port is not aligned on a 16-bit boundary, then ASSERT().
@param Port The I/O port to write.
@param OrData The value to OR with the read value from the I/O port.
@@ -341,7 +342,8 @@ IoOr16 (
are serialized.
If 16-bit I/O port operations are not supported, then ASSERT().
-
+ If Port is not aligned on a 16-bit boundary, then ASSERT().
+
@param Port The I/O port to write.
@param AndData The value to AND with the read value from the I/O port.
@@ -370,7 +372,8 @@ IoAnd16 (
I/O read and write operations are serialized.
If 16-bit I/O port operations are not supported, then ASSERT().
-
+ If Port is not aligned on a 16-bit boundary, then ASSERT().
+
@param Port The I/O port to write.
@param AndData The value to AND with the read value from the I/O port.
@param OrData The value to OR with the result of the AND operation.
@@ -396,6 +399,7 @@ IoAndThenOr16 (
the StartBit and the EndBit. The value of the bit field is returned.
If 16-bit I/O port operations are not supported, then ASSERT().
+ If Port is not aligned on a 16-bit boundary, then ASSERT().
If StartBit is greater than 15, then ASSERT().
If EndBit is greater than 15, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
@@ -406,7 +410,7 @@ IoAndThenOr16 (
@param EndBit The ordinal of the most significant bit in the bit field.
Range 0..15.
- @return The value read from Port.
+ @return The value read.
**/
UINT16
@@ -429,6 +433,7 @@ IoBitFieldRead16 (
left bits in Value are stripped.
If 16-bit I/O port operations are not supported, then ASSERT().
+ If Port is not aligned on a 16-bit boundary, then ASSERT().
If StartBit is greater than 15, then ASSERT().
If EndBit is greater than 15, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
@@ -469,6 +474,7 @@ IoBitFieldWrite16 (
operations are serialized. Extra left bits in OrData are stripped.
If 16-bit I/O port operations are not supported, then ASSERT().
+ If Port is not aligned on a 16-bit boundary, then ASSERT().
If StartBit is greater than 15, then ASSERT().
If EndBit is greater than 15, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
@@ -509,6 +515,7 @@ IoBitFieldOr16 (
are serialized. Extra left bits in AndData are stripped.
If 16-bit I/O port operations are not supported, then ASSERT().
+ If Port is not aligned on a 16-bit boundary, then ASSERT().
If StartBit is greater than 15, then ASSERT().
If EndBit is greater than 15, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
@@ -551,6 +558,7 @@ IoBitFieldAnd16 (
AndData and OrData are stripped.
If 16-bit I/O port operations are not supported, then ASSERT().
+ If Port is not aligned on a 16-bit boundary, then ASSERT().
If StartBit is greater than 15, then ASSERT().
If EndBit is greater than 15, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
@@ -593,6 +601,7 @@ IoBitFieldAndThenOr16 (
operations are serialized.
If 32-bit I/O port operations are not supported, then ASSERT().
+ If Port is not aligned on a 32-bit boundary, then ASSERT().
@param Port The I/O port to write.
@param OrData The value to OR with the read value from the I/O port.
@@ -621,6 +630,7 @@ IoOr32 (
are serialized.
If 32-bit I/O port operations are not supported, then ASSERT().
+ If Port is not aligned on a 32-bit boundary, then ASSERT().
@param Port The I/O port to write.
@param AndData The value to AND with the read value from the I/O port.
@@ -650,6 +660,7 @@ IoAnd32 (
I/O read and write operations are serialized.
If 32-bit I/O port operations are not supported, then ASSERT().
+ If Port is not aligned on a 32-bit boundary, then ASSERT().
@param Port The I/O port to write.
@param AndData The value to AND with the read value from the I/O port.
@@ -676,6 +687,7 @@ IoAndThenOr32 (
the StartBit and the EndBit. The value of the bit field is returned.
If 32-bit I/O port operations are not supported, then ASSERT().
+ If Port is not aligned on a 32-bit boundary, then ASSERT().
If StartBit is greater than 31, then ASSERT().
If EndBit is greater than 31, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
@@ -686,7 +698,7 @@ IoAndThenOr32 (
@param EndBit The ordinal of the most significant bit in the bit field.
Range 0..31.
- @return The value read from Port.
+ @return The value read.
**/
UINT32
@@ -709,6 +721,7 @@ IoBitFieldRead32 (
left bits in Value are stripped.
If 32-bit I/O port operations are not supported, then ASSERT().
+ If Port is not aligned on a 32-bit boundary, then ASSERT().
If StartBit is greater than 31, then ASSERT().
If EndBit is greater than 31, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
@@ -749,6 +762,7 @@ IoBitFieldWrite32 (
operations are serialized. Extra left bits in OrData are stripped.
If 32-bit I/O port operations are not supported, then ASSERT().
+ If Port is not aligned on a 32-bit boundary, then ASSERT().
If StartBit is greater than 31, then ASSERT().
If EndBit is greater than 31, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
@@ -789,6 +803,7 @@ IoBitFieldOr32 (
are serialized. Extra left bits in AndData are stripped.
If 32-bit I/O port operations are not supported, then ASSERT().
+ If Port is not aligned on a 32-bit boundary, then ASSERT().
If StartBit is greater than 31, then ASSERT().
If EndBit is greater than 31, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
@@ -831,6 +846,7 @@ IoBitFieldAnd32 (
AndData and OrData are stripped.
If 32-bit I/O port operations are not supported, then ASSERT().
+ If Port is not aligned on a 32-bit boundary, then ASSERT().
If StartBit is greater than 31, then ASSERT().
If EndBit is greater than 31, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
@@ -873,6 +889,7 @@ IoBitFieldAndThenOr32 (
operations are serialized.
If 64-bit I/O port operations are not supported, then ASSERT().
+ If Port is not aligned on a 64-bit boundary, then ASSERT().
@param Port The I/O port to write.
@param OrData The value to OR with the read value from the I/O port.
@@ -901,6 +918,7 @@ IoOr64 (
are serialized.
If 64-bit I/O port operations are not supported, then ASSERT().
+ If Port is not aligned on a 64-bit boundary, then ASSERT().
@param Port The I/O port to write.
@param AndData The value to AND with the read value from the I/O port.
@@ -930,6 +948,7 @@ IoAnd64 (
I/O read and write operations are serialized.
If 64-bit I/O port operations are not supported, then ASSERT().
+ If Port is not aligned on a 64-bit boundary, then ASSERT().
@param Port The I/O port to write.
@param AndData The value to AND with the read value from the I/O port.
@@ -956,6 +975,7 @@ IoAndThenOr64 (
the StartBit and the EndBit. The value of the bit field is returned.
If 64-bit I/O port operations are not supported, then ASSERT().
+ If Port is not aligned on a 64-bit boundary, then ASSERT().
If StartBit is greater than 63, then ASSERT().
If EndBit is greater than 63, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
@@ -989,6 +1009,7 @@ IoBitFieldRead64 (
left bits in Value are stripped.
If 64-bit I/O port operations are not supported, then ASSERT().
+ If Port is not aligned on a 64-bit boundary, then ASSERT().
If StartBit is greater than 63, then ASSERT().
If EndBit is greater than 63, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
@@ -1029,6 +1050,7 @@ IoBitFieldWrite64 (
operations are serialized. Extra left bits in OrData are stripped.
If 64-bit I/O port operations are not supported, then ASSERT().
+ If Port is not aligned on a 64-bit boundary, then ASSERT().
If StartBit is greater than 63, then ASSERT().
If EndBit is greater than 63, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
@@ -1069,6 +1091,7 @@ IoBitFieldOr64 (
are serialized. Extra left bits in AndData are stripped.
If 64-bit I/O port operations are not supported, then ASSERT().
+ If Port is not aligned on a 64-bit boundary, then ASSERT().
If StartBit is greater than 63, then ASSERT().
If EndBit is greater than 63, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
@@ -1111,6 +1134,7 @@ IoBitFieldAnd64 (
AndData and OrData are stripped.
If 64-bit I/O port operations are not supported, then ASSERT().
+ If Port is not aligned on a 64-bit boundary, then ASSERT().
If StartBit is greater than 63, then ASSERT().
If EndBit is greater than 63, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
@@ -1435,6 +1459,7 @@ MmioBitFieldAndThenOr8 (
all MMIO read and write operations are serialized.
If 16-bit MMIO register operations are not supported, then ASSERT().
+ If Address is not aligned on a 16-bit boundary, then ASSERT().
@param Address The MMIO register to write.
@param OrData The value to OR with the read value from the MMIO register.
@@ -1463,6 +1488,7 @@ MmioOr16 (
read and write operations are serialized.
If 16-bit MMIO register operations are not supported, then ASSERT().
+ If Address is not aligned on a 16-bit boundary, then ASSERT().
@param Address The MMIO register to write.
@param AndData The value to AND with the read value from the MMIO register.
@@ -1492,7 +1518,7 @@ MmioAnd16 (
must guarantee that all MMIO read and write operations are serialized.
If 16-bit MMIO register operations are not supported, then ASSERT().
-
+ If Address is not aligned on a 16-bit boundary, then ASSERT().
@param Address The MMIO register to write.
@param AndData The value to AND with the read value from the MMIO register.
@@ -1519,6 +1545,7 @@ MmioAndThenOr16 (
the StartBit and the EndBit. The value of the bit field is returned.
If 16-bit MMIO register operations are not supported, then ASSERT().
+ If Address is not aligned on a 16-bit boundary, then ASSERT().
If StartBit is greater than 15, then ASSERT().
If EndBit is greater than 15, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
@@ -1529,7 +1556,7 @@ MmioAndThenOr16 (
@param EndBit The ordinal of the most significant bit in the bit field.
Range 0..15.
- @return The value read from Address.
+ @return The value read.
**/
UINT16
@@ -1551,6 +1578,7 @@ MmioBitFieldRead16 (
MMIO register are preserved. The new value of the 16-bit register is returned.
If 16-bit MMIO register operations are not supported, then ASSERT().
+ If Address is not aligned on a 16-bit boundary, then ASSERT().
If StartBit is greater than 15, then ASSERT().
If EndBit is greater than 15, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
@@ -1592,6 +1620,7 @@ MmioBitFieldWrite16 (
are stripped.
If 16-bit MMIO register operations are not supported, then ASSERT().
+ If Address is not aligned on a 16-bit boundary, then ASSERT().
If StartBit is greater than 15, then ASSERT().
If EndBit is greater than 15, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
@@ -1633,6 +1662,7 @@ MmioBitFieldOr16 (
stripped.
If 16-bit MMIO register operations are not supported, then ASSERT().
+ If Address is not aligned on a 16-bit boundary, then ASSERT().
If StartBit is greater than 15, then ASSERT().
If EndBit is greater than 15, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
@@ -1675,6 +1705,7 @@ MmioBitFieldAnd16 (
serialized. Extra left bits in both AndData and OrData are stripped.
If 16-bit MMIO register operations are not supported, then ASSERT().
+ If Address is not aligned on a 16-bit boundary, then ASSERT().
If StartBit is greater than 15, then ASSERT().
If EndBit is greater than 15, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
@@ -1717,6 +1748,7 @@ MmioBitFieldAndThenOr16 (
all MMIO read and write operations are serialized.
If 32-bit MMIO register operations are not supported, then ASSERT().
+ If Address is not aligned on a 32-bit boundary, then ASSERT().
@param Address The MMIO register to write.
@param OrData The value to OR with the read value from the MMIO register.
@@ -1745,6 +1777,7 @@ MmioOr32 (
read and write operations are serialized.
If 32-bit MMIO register operations are not supported, then ASSERT().
+ If Address is not aligned on a 32-bit boundary, then ASSERT().
@param Address The MMIO register to write.
@param AndData The value to AND with the read value from the MMIO register.
@@ -1774,7 +1807,7 @@ MmioAnd32 (
must guarantee that all MMIO read and write operations are serialized.
If 32-bit MMIO register operations are not supported, then ASSERT().
-
+ If Address is not aligned on a 32-bit boundary, then ASSERT().
@param Address The MMIO register to write.
@param AndData The value to AND with the read value from the MMIO register.
@@ -1801,6 +1834,7 @@ MmioAndThenOr32 (
the StartBit and the EndBit. The value of the bit field is returned.
If 32-bit MMIO register operations are not supported, then ASSERT().
+ If Address is not aligned on a 32-bit boundary, then ASSERT().
If StartBit is greater than 31, then ASSERT().
If EndBit is greater than 31, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
@@ -1833,6 +1867,7 @@ MmioBitFieldRead32 (
MMIO register are preserved. The new value of the 32-bit register is returned.
If 32-bit MMIO register operations are not supported, then ASSERT().
+ If Address is not aligned on a 32-bit boundary, then ASSERT().
If StartBit is greater than 31, then ASSERT().
If EndBit is greater than 31, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
@@ -1874,6 +1909,7 @@ MmioBitFieldWrite32 (
are stripped.
If 32-bit MMIO register operations are not supported, then ASSERT().
+ If Address is not aligned on a 32-bit boundary, then ASSERT().
If StartBit is greater than 31, then ASSERT().
If EndBit is greater than 31, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
@@ -1915,6 +1951,7 @@ MmioBitFieldOr32 (
stripped.
If 32-bit MMIO register operations are not supported, then ASSERT().
+ If Address is not aligned on a 32-bit boundary, then ASSERT().
If StartBit is greater than 31, then ASSERT().
If EndBit is greater than 31, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
@@ -1957,6 +1994,7 @@ MmioBitFieldAnd32 (
serialized. Extra left bits in both AndData and OrData are stripped.
If 32-bit MMIO register operations are not supported, then ASSERT().
+ If Address is not aligned on a 32-bit boundary, then ASSERT().
If StartBit is greater than 31, then ASSERT().
If EndBit is greater than 31, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
@@ -1999,6 +2037,7 @@ MmioBitFieldAndThenOr32 (
all MMIO read and write operations are serialized.
If 64-bit MMIO register operations are not supported, then ASSERT().
+ If Address is not aligned on a 64-bit boundary, then ASSERT().
@param Address The MMIO register to write.
@param OrData The value to OR with the read value from the MMIO register.
@@ -2027,6 +2066,7 @@ MmioOr64 (
read and write operations are serialized.
If 64-bit MMIO register operations are not supported, then ASSERT().
+ If Address is not aligned on a 64-bit boundary, then ASSERT().
@param Address The MMIO register to write.
@param AndData The value to AND with the read value from the MMIO register.
@@ -2056,7 +2096,7 @@ MmioAnd64 (
must guarantee that all MMIO read and write operations are serialized.
If 64-bit MMIO register operations are not supported, then ASSERT().
-
+ If Address is not aligned on a 64-bit boundary, then ASSERT().
@param Address The MMIO register to write.
@param AndData The value to AND with the read value from the MMIO register.
@@ -2083,6 +2123,7 @@ MmioAndThenOr64 (
the StartBit and the EndBit. The value of the bit field is returned.
If 64-bit MMIO register operations are not supported, then ASSERT().
+ If Address is not aligned on a 64-bit boundary, then ASSERT().
If StartBit is greater than 63, then ASSERT().
If EndBit is greater than 63, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
@@ -2115,6 +2156,7 @@ MmioBitFieldRead64 (
MMIO register are preserved. The new value of the 64-bit register is returned.
If 64-bit MMIO register operations are not supported, then ASSERT().
+ If Address is not aligned on a 64-bit boundary, then ASSERT().
If StartBit is greater than 63, then ASSERT().
If EndBit is greater than 63, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
@@ -2156,6 +2198,7 @@ MmioBitFieldWrite64 (
are stripped.
If 64-bit MMIO register operations are not supported, then ASSERT().
+ If Address is not aligned on a 64-bit boundary, then ASSERT().
If StartBit is greater than 63, then ASSERT().
If EndBit is greater than 63, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
@@ -2197,6 +2240,7 @@ MmioBitFieldOr64 (
stripped.
If 64-bit MMIO register operations are not supported, then ASSERT().
+ If Address is not aligned on a 64-bit boundary, then ASSERT().
If StartBit is greater than 63, then ASSERT().
If EndBit is greater than 63, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
@@ -2239,6 +2283,7 @@ MmioBitFieldAnd64 (
serialized. Extra left bits in both AndData and OrData are stripped.
If 64-bit MMIO register operations are not supported, then ASSERT().
+ If Address is not aligned on a 64-bit boundary, then ASSERT().
If StartBit is greater than 63, then ASSERT().
If EndBit is greater than 63, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
diff --git a/MdePkg/Library/PeiIoLibCpuIo/IoLib.c b/MdePkg/Library/PeiIoLibCpuIo/IoLib.c
index 5d94b56124..57d84cfd5c 100644
--- a/MdePkg/Library/PeiIoLibCpuIo/IoLib.c
+++ b/MdePkg/Library/PeiIoLibCpuIo/IoLib.c
@@ -31,7 +31,7 @@
@param Port The I/O port to read.
- @return The value read from Port.
+ @return The value read.
**/
UINT8
@@ -91,10 +91,11 @@ IoWrite8 (
serialized.
If 16-bit I/O port operations are not supported, then ASSERT().
+ If Port is not aligned on a 16-bit boundary, then ASSERT().
@param Port The I/O port to read.
- @return The value read from Port.
+ @return The value read.
**/
UINT16
@@ -124,7 +125,8 @@ IoRead16 (
operations are serialized.
If 16-bit I/O port operations are not supported, then ASSERT().
-
+ If Port is not aligned on a 16-bit boundary, then ASSERT().
+
@param Port The I/O port to write.
@param Value The value to write to the I/O port.
@@ -160,10 +162,11 @@ IoWrite16 (
serialized.
If 32-bit I/O port operations are not supported, then ASSERT().
-
+ If Port is not aligned on a 32-bit boundary, then ASSERT().
+
@param Port The I/O port to read.
- @return The value read from Port.
+ @return The value read.
**/
UINT32
@@ -193,7 +196,8 @@ IoRead32 (
operations are serialized.
If 32-bit I/O port operations are not supported, then ASSERT().
-
+ If Port is not aligned on a 32-bit boundary, then ASSERT().
+
@param Port The I/O port to write.
@param Value The value to write to the I/O port.
@@ -229,10 +233,11 @@ IoWrite32 (
serialized.
If 64-bit I/O port operations are not supported, then ASSERT().
+ If Port is not aligned on a 64-bit boundary, then ASSERT().
@param Port The I/O port to read.
- @return The value read from Port.
+ @return The value read.
**/
UINT64
@@ -262,6 +267,7 @@ IoRead64 (
operations are serialized.
If 64-bit I/O port operations are not supported, then ASSERT().
+ If Port is not aligned on a 64-bit boundary, then ASSERT().
@param Port The I/O port to write.
@param Value The value to write to the I/O port.
@@ -301,7 +307,7 @@ IoWrite64 (
@param Address The MMIO register to read.
- @return The value read from Port.
+ @return The value read.
**/
UINT8
@@ -331,8 +337,7 @@ MmioRead8 (
@param Address The MMIO register to write.
@param Value The value to write to the MMIO register.
-
- @return The Value written back to Mmio register.
+
**/
UINT8
EFIAPI
@@ -360,10 +365,11 @@ MmioWrite8 (
operations are serialized.
If 16-bit MMIO register operations are not supported, then ASSERT().
+ If Address is not aligned on a 16-bit boundary, then ASSERT().
@param Address The MMIO register to read.
- @return The value read from Address.
+ @return The value read.
**/
UINT16
@@ -394,11 +400,10 @@ MmioRead16 (
and write operations are serialized.
If 16-bit MMIO register operations are not supported, then ASSERT().
+ If Address is not aligned on a 16-bit boundary, then ASSERT().
@param Address The MMIO register to write.
@param Value The value to write to the MMIO register.
-
- @return The Value written back to Mmio register
**/
UINT16
@@ -430,10 +435,11 @@ MmioWrite16 (
operations are serialized.
If 32-bit MMIO register operations are not supported, then ASSERT().
+ If Address is not aligned on a 32-bit boundary, then ASSERT().
@param Address The MMIO register to read.
- @return The value read from Address.
+ @return The value read.
**/
UINT32
@@ -464,11 +470,10 @@ MmioRead32 (
and write operations are serialized.
If 32-bit MMIO register operations are not supported, then ASSERT().
+ If Address is not aligned on a 32-bit boundary, then ASSERT().
@param Address The MMIO register to write.
@param Value The value to write to the MMIO register.
-
- @return The Value written back to Mmio register
**/
UINT32
@@ -500,10 +505,11 @@ MmioWrite32 (
operations are serialized.
If 64-bit MMIO register operations are not supported, then ASSERT().
+ If Address is not aligned on a 64-bit boundary, then ASSERT().
@param Address The MMIO register to read.
- @return The value read from Address.
+ @return The value read.
**/
UINT64
@@ -534,11 +540,11 @@ MmioRead64 (
and write operations are serialized.
If 64-bit MMIO register operations are not supported, then ASSERT().
+ If Address is not aligned on a 64-bit boundary, then ASSERT().
@param Address The MMIO register to write.
@param Value The value to write to the MMIO register.
- @return The Value written back to Mmio register
**/
UINT64
EFIAPI
diff --git a/MdePkg/Library/PeiIoLibCpuIo/IoLibMmioBuffer.c b/MdePkg/Library/PeiIoLibCpuIo/IoLibMmioBuffer.c
index 20d926f9f0..aa8f71e996 100644
--- a/MdePkg/Library/PeiIoLibCpuIo/IoLibMmioBuffer.c
+++ b/MdePkg/Library/PeiIoLibCpuIo/IoLibMmioBuffer.c
@@ -33,10 +33,10 @@
@param StartAddress Starting address for the MMIO region to be copied from.
- @param Length Size in bytes of the copy.
+ @param Length The size, in bytes, of Buffer.
@param Buffer Pointer to a system memory buffer receiving the data read.
- @return Pointer to a system memory buffer receiving the data read.
+ @return Buffer
**/
UINT8 *
@@ -77,10 +77,10 @@ MmioReadBuffer8 (
If Buffer is not aligned on a 16-bit boundary, then ASSERT().
@param StartAddress Starting address for the MMIO region to be copied from.
- @param Length Size in bytes of the copy.
+ @param Length The size, in bytes, of Buffer.
@param Buffer Pointer to a system memory buffer receiving the data read.
- @return Pointer to a system memory buffer receiving the data read.
+ @return Buffer
**/
UINT16 *
@@ -128,10 +128,10 @@ MmioReadBuffer16 (
If Buffer is not aligned on a 32-bit boundary, then ASSERT().
@param StartAddress Starting address for the MMIO region to be copied from.
- @param Length Size in bytes of the copy.
+ @param Length The size, in bytes, of Buffer.
@param Buffer Pointer to a system memory buffer receiving the data read.
- @return Pointer to a system memory buffer receiving the data read.
+ @return Buffer
**/
UINT32 *
@@ -179,10 +179,10 @@ MmioReadBuffer32 (
If Buffer is not aligned on a 64-bit boundary, then ASSERT().
@param StartAddress Starting address for the MMIO region to be copied from.
- @param Length Size in bytes of the copy.
+ @param Length The size, in bytes, of Buffer.
@param Buffer Pointer to a system memory buffer receiving the data read.
- @return Pointer to a system memory buffer receiving the data read.
+ @return Buffer
**/
UINT64 *
@@ -227,10 +227,10 @@ MmioReadBuffer64 (
@param StartAddress Starting address for the MMIO region to be copied to.
- @param Length Size in bytes of the copy.
+ @param Length The size, in bytes, of Buffer.
@param Buffer Pointer to a system memory buffer containing the data to write.
- @return Pointer to a system memory buffer containing the data to write.
+ @return Size in bytes of the copy.
**/
UINT8 *
@@ -273,10 +273,10 @@ MmioWriteBuffer8 (
If Buffer is not aligned on a 16-bit boundary, then ASSERT().
@param StartAddress Starting address for the MMIO region to be copied to.
- @param Length Size in bytes of the copy.
+ @param Length The size, in bytes, of Buffer.
@param Buffer Pointer to a system memory buffer containing the data to write.
- @return Pointer to a system memory buffer containing the data to write.
+ @return Size in bytes of the copy.
**/
UINT16 *
@@ -327,10 +327,10 @@ MmioWriteBuffer16 (
If Buffer is not aligned on a 32-bit boundary, then ASSERT().
@param StartAddress Starting address for the MMIO region to be copied to.
- @param Length Size in bytes of the copy.
+ @param Length The size, in bytes, of Buffer.
@param Buffer Pointer to a system memory buffer containing the data to write.
- @return Pointer to a system memory buffer containing the data to write.
+ @return Size in bytes of the copy.
**/
UINT32 *
@@ -380,10 +380,10 @@ MmioWriteBuffer32 (
If Buffer is not aligned on a 64-bit boundary, then ASSERT().
@param StartAddress Starting address for the MMIO region to be copied to.
- @param Length Size in bytes of the copy.
+ @param Length The size, in bytes, of Buffer.
@param Buffer Pointer to a system memory buffer containing the data to write.
- @return Pointer to a system memory buffer containing the data to write.
+ @return Size in bytes of the copy.
**/
UINT64 *