]> git.proxmox.com Git - mirror_edk2.git/commitdiff
Synchronize the h files with c files.
authorgikidy <gikidy@6f19259b-4bc3-4df7-8a09-765794883524>
Wed, 10 Dec 2008 06:13:43 +0000 (06:13 +0000)
committergikidy <gikidy@6f19259b-4bc3-4df7-8a09-765794883524>
Wed, 10 Dec 2008 06:13:43 +0000 (06:13 +0000)
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6967 6f19259b-4bc3-4df7-8a09-765794883524

12 files changed:
MdePkg/Include/Library/DebugLib.h
MdePkg/Include/Library/HobLib.h
MdePkg/Include/Library/IoLib.h
MdePkg/Library/BaseIoLibIntrinsic/IoHighLevel.c
MdePkg/Library/BaseIoLibIntrinsic/IoLib.c
MdePkg/Library/BaseIoLibIntrinsic/IoLibGcc.c
MdePkg/Library/BaseIoLibIntrinsic/IoLibIcc.c
MdePkg/Library/BaseIoLibIntrinsic/IoLibIpf.c
MdePkg/Library/BaseIoLibIntrinsic/IoLibMmioBuffer.c
MdePkg/Library/BaseIoLibIntrinsic/IoLibMsc.c
MdePkg/Library/UefiApplicationEntryPoint/ApplicationEntryPoint.c
MdePkg/Library/UefiUsbLib/Hid.c

index 764bccc87ca5ac9161debf65001aad08a020fa25..e25713f5c572f42d610f1a1f2fe7224470af5e26 100644 (file)
@@ -129,7 +129,7 @@ DebugAssert (
   PcdDebugClearMemoryValue, and returns Buffer.\r
 \r
   If Buffer is NULL, then ASSERT().\r
-  If Length is greater than (MAX_ADDRESS -Buffer + 1), then ASSERT(). \r
+  If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). \r
 \r
   @param   Buffer  Pointer to the target buffer to be filled with PcdDebugClearMemoryValue.\r
   @param   Length  Number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue. \r
index 278133d9910c055fe55ad546f5fea1a815a4ed5a..08cb63e936a541381aa7044582d4b16c2a4f82c7 100644 (file)
@@ -422,7 +422,7 @@ BuildMemoryAllocationHob (
 \r
   @param  Hob   A pointer to a HOB.\r
   \r
-  @return HobType\r
+  @return HobType.\r
   \r
 **/\r
 #define GET_HOB_TYPE(HobStart) \\r
@@ -436,7 +436,7 @@ BuildMemoryAllocationHob (
 \r
   @param  Hob   A pointer to a HOB.\r
 \r
-  @return HobLength\r
+  @return HobLength.\r
 \r
 **/\r
 #define GET_HOB_LENGTH(HobStart) \\r
@@ -479,7 +479,7 @@ BuildMemoryAllocationHob (
 \r
   @param   GuidHob   A pointer to a HOB.\r
 \r
-  @return  A pointer to the data buffer in a HOB\r
+  @return  A pointer to the data buffer in a HOB.\r
   \r
 **/\r
 #define GET_GUID_HOB_DATA(HobStart) \\r
@@ -493,7 +493,7 @@ BuildMemoryAllocationHob (
 \r
   @param   GuidHob   A pointer to a HOB.\r
 \r
-  @return  The size of the data buffer\r
+  @return  The size of the data buffer.\r
 **/\r
 #define GET_GUID_HOB_DATA_SIZE(HobStart) \\r
   (UINT16)(GET_HOB_LENGTH (HobStart) - sizeof (EFI_HOB_GUID_TYPE))\r
index 289c10ff54386aa52d9958ff808d44616f5ce988..e484bef9ecc3cc49b17f947eca502c6cd22939b7 100644 (file)
@@ -1237,6 +1237,8 @@ MmioRead8 (
 \r
   @param  Address The MMIO register to write.\r
   @param  Value   The value to write to the MMIO register.\r
+  \r
+  @return Value.\r
 \r
 **/\r
 UINT8\r
@@ -1525,6 +1527,8 @@ MmioRead16 (
 \r
   @param  Address The MMIO register to write.\r
   @param  Value   The value to write to the MMIO register.\r
+  \r
+  @return Value.\r
 \r
 **/\r
 UINT16\r
@@ -1820,6 +1824,8 @@ MmioRead32 (
 \r
   @param  Address The MMIO register to write.\r
   @param  Value   The value to write to the MMIO register.\r
+  \r
+  @return Value.\r
 \r
 **/\r
 UINT32\r
index 344a9faf8bff75aa894584796b2a6d0f1c62e243..ece2f9710204d05d9a342ac8fae19b43def16d0b 100644 (file)
@@ -127,8 +127,7 @@ IoAndThenOr8 (
   @param  EndBit    The ordinal of the most significant bit in the bit field.\r
                     Range 0..7.\r
 \r
-  @return The value read from I/O port specified by StartBit and\r
-          EndBit.\r
+  @return The value read.\r
 \r
 **/\r
 UINT8\r
@@ -314,6 +313,7 @@ IoBitFieldAndThenOr8 (
   operations are serialized.\r
 \r
   If 16-bit I/O port operations are not supported, then ASSERT().\r
+  If Port is not aligned on a 16-bit boundary, then ASSERT().\r
 \r
   @param  Port    The I/O port to write.\r
   @param  OrData  The value to OR with the read value from the I/O port.\r
@@ -342,7 +342,8 @@ IoOr16 (
   are serialized.\r
 \r
   If 16-bit I/O port operations are not supported, then ASSERT().\r
-\r
+  If Port is not aligned on a 16-bit boundary, then ASSERT().\r
+  \r
   @param  Port    The I/O port to write.\r
   @param  AndData The value to AND with the read value from the I/O port.\r
 \r
@@ -371,7 +372,8 @@ IoAnd16 (
   I/O read and write operations are serialized.\r
 \r
   If 16-bit I/O port operations are not supported, then ASSERT().\r
-\r
+  If Port is not aligned on a 16-bit boundary, then ASSERT().\r
+  \r
   @param  Port    The I/O port to write.\r
   @param  AndData The value to AND with the read value from the I/O port.\r
   @param  OrData  The value to OR with the result of the AND operation.\r
@@ -397,6 +399,7 @@ IoAndThenOr16 (
   the StartBit and the EndBit. The value of the bit field is returned.\r
 \r
   If 16-bit I/O port operations are not supported, then ASSERT().\r
+  If Port 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
@@ -407,8 +410,7 @@ IoAndThenOr16 (
   @param  EndBit    The ordinal of the most significant bit in the bit field.\r
                     Range 0..15.\r
 \r
-  @return The value read from I/O port specified by StartBit and\r
-          EndBit.\r
+  @return The value read.\r
 \r
 **/\r
 UINT16\r
@@ -431,6 +433,7 @@ IoBitFieldRead16 (
   left bits in Value are stripped.\r
 \r
   If 16-bit I/O port operations are not supported, then ASSERT().\r
+  If Port 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
@@ -471,6 +474,7 @@ IoBitFieldWrite16 (
   operations are serialized. Extra left bits in OrData are stripped.\r
 \r
   If 16-bit I/O port operations are not supported, then ASSERT().\r
+  If Port 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
@@ -511,6 +515,7 @@ IoBitFieldOr16 (
   are serialized. Extra left bits in AndData are stripped.\r
 \r
   If 16-bit I/O port operations are not supported, then ASSERT().\r
+  If Port 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
@@ -553,6 +558,7 @@ IoBitFieldAnd16 (
   AndData and OrData are stripped.\r
 \r
   If 16-bit I/O port operations are not supported, then ASSERT().\r
+  If Port 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
@@ -595,6 +601,7 @@ IoBitFieldAndThenOr16 (
   operations are serialized.\r
 \r
   If 32-bit I/O port operations are not supported, then ASSERT().\r
+  If Port is not aligned on a 32-bit boundary, then ASSERT().\r
 \r
   @param  Port    The I/O port to write.\r
   @param  OrData  The value to OR with the read value from the I/O port.\r
@@ -623,6 +630,7 @@ IoOr32 (
   are serialized.\r
 \r
   If 32-bit I/O port operations are not supported, then ASSERT().\r
+  If Port is not aligned on a 32-bit boundary, then ASSERT().\r
 \r
   @param  Port    The I/O port to write.\r
   @param  AndData The value to AND with the read value from the I/O port.\r
@@ -652,6 +660,7 @@ IoAnd32 (
   I/O read and write operations are serialized.\r
 \r
   If 32-bit I/O port operations are not supported, then ASSERT().\r
+  If Port is not aligned on a 32-bit boundary, then ASSERT().\r
 \r
   @param  Port    The I/O port to write.\r
   @param  AndData The value to AND with the read value from the I/O port.\r
@@ -678,6 +687,7 @@ IoAndThenOr32 (
   the StartBit and the EndBit. The value of the bit field is returned.\r
 \r
   If 32-bit I/O port operations are not supported, then ASSERT().\r
+  If Port 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
@@ -688,8 +698,7 @@ IoAndThenOr32 (
   @param  EndBit    The ordinal of the most significant bit in the bit field.\r
                     Range 0..31.\r
 \r
-  @return The value read from I/O port specified by StartBit and\r
-          EndBit.\r
+  @return The value read.\r
 \r
 **/\r
 UINT32\r
@@ -712,6 +721,7 @@ IoBitFieldRead32 (
   left bits in Value are stripped.\r
 \r
   If 32-bit I/O port operations are not supported, then ASSERT().\r
+  If Port 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
@@ -752,6 +762,7 @@ IoBitFieldWrite32 (
   operations are serialized. Extra left bits in OrData are stripped.\r
 \r
   If 32-bit I/O port operations are not supported, then ASSERT().\r
+  If Port 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
@@ -792,6 +803,7 @@ IoBitFieldOr32 (
   are serialized. Extra left bits in AndData are stripped.\r
 \r
   If 32-bit I/O port operations are not supported, then ASSERT().\r
+  If Port 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
@@ -834,6 +846,7 @@ IoBitFieldAnd32 (
   AndData and OrData are stripped.\r
 \r
   If 32-bit I/O port operations are not supported, then ASSERT().\r
+  If Port 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
@@ -876,6 +889,7 @@ IoBitFieldAndThenOr32 (
   operations are serialized.\r
 \r
   If 64-bit I/O port operations are not supported, then ASSERT().\r
+  If Port is not aligned on a 64-bit boundary, then ASSERT().\r
 \r
   @param  Port    The I/O port to write.\r
   @param  OrData  The value to OR with the read value from the I/O port.\r
@@ -904,6 +918,7 @@ IoOr64 (
   are serialized.\r
 \r
   If 64-bit I/O port operations are not supported, then ASSERT().\r
+  If Port is not aligned on a 64-bit boundary, then ASSERT().\r
 \r
   @param  Port    The I/O port to write.\r
   @param  AndData The value to AND with the read value from the I/O port.\r
@@ -933,6 +948,7 @@ IoAnd64 (
   I/O read and write operations are serialized.\r
 \r
   If 64-bit I/O port operations are not supported, then ASSERT().\r
+  If Port is not aligned on a 64-bit boundary, then ASSERT().\r
 \r
   @param  Port    The I/O port to write.\r
   @param  AndData The value to AND with the read value from the I/O port.\r
@@ -959,6 +975,7 @@ IoAndThenOr64 (
   the StartBit and the EndBit. The value of the bit field is returned.\r
 \r
   If 64-bit I/O port operations are not supported, then ASSERT().\r
+  If Port is not aligned on a 64-bit boundary, then ASSERT().\r
   If StartBit is greater than 63, then ASSERT().\r
   If EndBit is greater than 63, then ASSERT().\r
   If EndBit is less than StartBit, then ASSERT().\r
@@ -969,8 +986,7 @@ IoAndThenOr64 (
   @param  EndBit    The ordinal of the most significant bit in the bit field.\r
                     Range 0..63.\r
 \r
-  @return The value read from I/O port specified by StartBit and\r
-          EndBit.\r
+  @return The value read.\r
 \r
 **/\r
 UINT64\r
@@ -993,6 +1009,7 @@ IoBitFieldRead64 (
   left bits in Value are stripped.\r
 \r
   If 64-bit I/O port operations are not supported, then ASSERT().\r
+  If Port is not aligned on a 64-bit boundary, then ASSERT().\r
   If StartBit is greater than 63, then ASSERT().\r
   If EndBit is greater than 63, then ASSERT().\r
   If EndBit is less than StartBit, then ASSERT().\r
@@ -1033,6 +1050,7 @@ IoBitFieldWrite64 (
   operations are serialized. Extra left bits in OrData are stripped.\r
 \r
   If 64-bit I/O port operations are not supported, then ASSERT().\r
+  If Port is not aligned on a 64-bit boundary, then ASSERT().\r
   If StartBit is greater than 63, then ASSERT().\r
   If EndBit is greater than 63, then ASSERT().\r
   If EndBit is less than StartBit, then ASSERT().\r
@@ -1073,6 +1091,7 @@ IoBitFieldOr64 (
   are serialized. Extra left bits in AndData are stripped.\r
 \r
   If 64-bit I/O port operations are not supported, then ASSERT().\r
+  If Port is not aligned on a 64-bit boundary, then ASSERT().\r
   If StartBit is greater than 63, then ASSERT().\r
   If EndBit is greater than 63, then ASSERT().\r
   If EndBit is less than StartBit, then ASSERT().\r
@@ -1115,6 +1134,7 @@ IoBitFieldAnd64 (
   AndData and OrData are stripped.\r
 \r
   If 64-bit I/O port operations are not supported, then ASSERT().\r
+  If Port is not aligned on a 64-bit boundary, then ASSERT().\r
   If StartBit is greater than 63, then ASSERT().\r
   If EndBit is greater than 63, then ASSERT().\r
   If EndBit is less than StartBit, then ASSERT().\r
@@ -1251,8 +1271,7 @@ MmioAndThenOr8 (
   @param  EndBit    The ordinal of the most significant bit in the bit field.\r
                     Range 0..7.\r
 \r
-  @return The value read from I/O port specified by StartBit and\r
-          EndBit.\r
+  @return The value read.\r
 \r
 **/\r
 UINT8\r
@@ -1440,6 +1459,7 @@ MmioBitFieldAndThenOr8 (
   all MMIO read and write operations are serialized.\r
 \r
   If 16-bit MMIO register operations are not supported, then ASSERT().\r
+  If Address is not aligned on a 16-bit boundary, then ASSERT().\r
 \r
   @param  Address The MMIO register to write.\r
   @param  OrData  The value to OR with the read value from the MMIO register.\r
@@ -1468,6 +1488,7 @@ MmioOr16 (
   read and write operations are serialized.\r
 \r
   If 16-bit MMIO register operations are not supported, then ASSERT().\r
+  If Address is not aligned on a 16-bit boundary, then ASSERT().\r
 \r
   @param  Address The MMIO register to write.\r
   @param  AndData The value to AND with the read value from the MMIO register.\r
@@ -1497,7 +1518,7 @@ MmioAnd16 (
   must guarantee that all MMIO read and write operations are serialized.\r
 \r
   If 16-bit MMIO register operations are not supported, then ASSERT().\r
-\r
+  If Address is not aligned on a 16-bit boundary, then ASSERT().\r
 \r
   @param  Address The MMIO register to write.\r
   @param  AndData The value to AND with the read value from the MMIO register.\r
@@ -1524,6 +1545,7 @@ MmioAndThenOr16 (
   the StartBit and the EndBit. The value of the bit field is returned.\r
 \r
   If 16-bit MMIO register operations are not supported, 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
@@ -1534,8 +1556,7 @@ MmioAndThenOr16 (
   @param  EndBit    The ordinal of the most significant bit in the bit field.\r
                     Range 0..15.\r
 \r
-  @return The value read from I/O port specified by StartBit and\r
-          EndBit.\r
+  @return The value read.\r
 \r
 **/\r
 UINT16\r
@@ -1557,6 +1578,7 @@ MmioBitFieldRead16 (
   MMIO register are preserved. The new value of the 16-bit register is returned.\r
 \r
   If 16-bit MMIO register operations are not supported, 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
@@ -1598,6 +1620,7 @@ MmioBitFieldWrite16 (
   are stripped.\r
 \r
   If 16-bit MMIO register operations are not supported, 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
@@ -1639,6 +1662,7 @@ MmioBitFieldOr16 (
   stripped.\r
 \r
   If 16-bit MMIO register operations are not supported, 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
@@ -1681,6 +1705,7 @@ MmioBitFieldAnd16 (
   serialized. Extra left bits in both AndData and OrData are stripped.\r
 \r
   If 16-bit MMIO register operations are not supported, 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
@@ -1723,6 +1748,7 @@ MmioBitFieldAndThenOr16 (
   all MMIO read and write operations are serialized.\r
 \r
   If 32-bit MMIO register operations are not supported, then ASSERT().\r
+  If Address is not aligned on a 32-bit boundary, then ASSERT().\r
 \r
   @param  Address The MMIO register to write.\r
   @param  OrData  The value to OR with the read value from the MMIO register.\r
@@ -1751,6 +1777,7 @@ MmioOr32 (
   read and write operations are serialized.\r
 \r
   If 32-bit MMIO register operations are not supported, then ASSERT().\r
+  If Address is not aligned on a 32-bit boundary, then ASSERT().\r
 \r
   @param  Address The MMIO register to write.\r
   @param  AndData The value to AND with the read value from the MMIO register.\r
@@ -1780,7 +1807,7 @@ MmioAnd32 (
   must guarantee that all MMIO read and write operations are serialized.\r
 \r
   If 32-bit MMIO register operations are not supported, then ASSERT().\r
-\r
+  If Address is not aligned on a 32-bit boundary, then ASSERT().\r
 \r
   @param  Address The MMIO register to write.\r
   @param  AndData The value to AND with the read value from the MMIO register.\r
@@ -1807,6 +1834,7 @@ MmioAndThenOr32 (
   the StartBit and the EndBit. The value of the bit field is returned.\r
 \r
   If 32-bit MMIO register operations are not supported, 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
@@ -1817,8 +1845,7 @@ MmioAndThenOr32 (
   @param  EndBit    The ordinal of the most significant bit in the bit field.\r
                     Range 0..31.\r
 \r
-  @return The value read from I/O port specified by StartBit and\r
-          EndBit.\r
+  @return The value read.\r
 \r
 **/\r
 UINT32\r
@@ -1840,6 +1867,7 @@ MmioBitFieldRead32 (
   MMIO register are preserved. The new value of the 32-bit register is returned.\r
 \r
   If 32-bit MMIO register operations are not supported, 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
@@ -1881,6 +1909,7 @@ MmioBitFieldWrite32 (
   are stripped.\r
 \r
   If 32-bit MMIO register operations are not supported, 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
@@ -1922,6 +1951,7 @@ MmioBitFieldOr32 (
   stripped.\r
 \r
   If 32-bit MMIO register operations are not supported, 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
@@ -1964,6 +1994,7 @@ MmioBitFieldAnd32 (
   serialized. Extra left bits in both AndData and OrData are stripped.\r
 \r
   If 32-bit MMIO register operations are not supported, 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
@@ -2006,6 +2037,7 @@ MmioBitFieldAndThenOr32 (
   all MMIO read and write operations are serialized.\r
 \r
   If 64-bit MMIO register operations are not supported, then ASSERT().\r
+  If Address is not aligned on a 64-bit boundary, then ASSERT().\r
 \r
   @param  Address The MMIO register to write.\r
   @param  OrData  The value to OR with the read value from the MMIO register.\r
@@ -2034,6 +2066,7 @@ MmioOr64 (
   read and write operations are serialized.\r
 \r
   If 64-bit MMIO register operations are not supported, then ASSERT().\r
+  If Address is not aligned on a 64-bit boundary, then ASSERT().\r
 \r
   @param  Address The MMIO register to write.\r
   @param  AndData The value to AND with the read value from the MMIO register.\r
@@ -2063,7 +2096,7 @@ MmioAnd64 (
   must guarantee that all MMIO read and write operations are serialized.\r
 \r
   If 64-bit MMIO register operations are not supported, then ASSERT().\r
-\r
+  If Address is not aligned on a 64-bit boundary, then ASSERT().\r
 \r
   @param  Address The MMIO register to write.\r
   @param  AndData The value to AND with the read value from the MMIO register.\r
@@ -2090,6 +2123,7 @@ MmioAndThenOr64 (
   the StartBit and the EndBit. The value of the bit field is returned.\r
 \r
   If 64-bit MMIO register operations are not supported, then ASSERT().\r
+  If Address is not aligned on a 64-bit boundary, then ASSERT().\r
   If StartBit is greater than 63, then ASSERT().\r
   If EndBit is greater than 63, then ASSERT().\r
   If EndBit is less than StartBit, then ASSERT().\r
@@ -2100,8 +2134,7 @@ MmioAndThenOr64 (
   @param  EndBit    The ordinal of the most significant bit in the bit field.\r
                     Range 0..63.\r
 \r
-  @return The value read from I/O port specified by StartBit and\r
-          EndBit.\r
+  @return The value read.\r
 \r
 **/\r
 UINT64\r
@@ -2123,6 +2156,7 @@ MmioBitFieldRead64 (
   MMIO register are preserved. The new value of the 64-bit register is returned.\r
 \r
   If 64-bit MMIO register operations are not supported, then ASSERT().\r
+  If Address is not aligned on a 64-bit boundary, then ASSERT().\r
   If StartBit is greater than 63, then ASSERT().\r
   If EndBit is greater than 63, then ASSERT().\r
   If EndBit is less than StartBit, then ASSERT().\r
@@ -2164,6 +2198,7 @@ MmioBitFieldWrite64 (
   are stripped.\r
 \r
   If 64-bit MMIO register operations are not supported, then ASSERT().\r
+  If Address is not aligned on a 64-bit boundary, then ASSERT().\r
   If StartBit is greater than 63, then ASSERT().\r
   If EndBit is greater than 63, then ASSERT().\r
   If EndBit is less than StartBit, then ASSERT().\r
@@ -2205,6 +2240,7 @@ MmioBitFieldOr64 (
   stripped.\r
 \r
   If 64-bit MMIO register operations are not supported, then ASSERT().\r
+  If Address is not aligned on a 64-bit boundary, then ASSERT().\r
   If StartBit is greater than 63, then ASSERT().\r
   If EndBit is greater than 63, then ASSERT().\r
   If EndBit is less than StartBit, then ASSERT().\r
@@ -2247,6 +2283,7 @@ MmioBitFieldAnd64 (
   serialized. Extra left bits in both AndData and OrData are stripped.\r
 \r
   If 64-bit MMIO register operations are not supported, then ASSERT().\r
+  If Address is not aligned on a 64-bit boundary, then ASSERT().\r
   If StartBit is greater than 63, then ASSERT().\r
   If EndBit is greater than 63, then ASSERT().\r
   If EndBit is less than StartBit, then ASSERT().\r
index 86efa6db6a16038be309ff69f51fd90fcf174a36..1e8cb666b30b55ff746dc7d51af8b0f22db3006a 100644 (file)
   serialized.\r
 \r
   If 64-bit I/O port operations are not supported, then ASSERT().\r
+  If Port is not aligned on a 64-bit boundary, then ASSERT().\r
 \r
   @param  Port  The I/O port to read.\r
 \r
-  @return Always return zero.\r
+  @return The value read.\r
 \r
 **/\r
 UINT64\r
@@ -46,11 +47,12 @@ IoRead64 (
   operations are serialized.\r
 \r
   If 64-bit I/O port operations are not supported, then ASSERT().\r
+  If Port is not aligned on a 64-bit boundary, then ASSERT().\r
 \r
   @param  Port  The I/O port to write.\r
   @param  Value The value to write to the I/O port.\r
 \r
-  @return Always return zero.\r
+  @return The value written the I/O port.\r
 \r
 **/\r
 UINT64\r
index 1377650042a8accb296039b7d002ec8476cbc329..0cca85ee24a7e6a4aac7e4ba2bab14563aa30fb7 100644 (file)
@@ -35,7 +35,7 @@
 \r
   @param  Address The MMIO register to read.\r
 \r
-  @return The value read from Address.\r
+  @return The value read.\r
 \r
 **/\r
 UINT8\r
@@ -58,10 +58,9 @@ MmioRead8 (
 \r
   @param  Address The MMIO register to write.\r
   @param  Value   The value to write to the MMIO register.\r
+  \r
+  @return Value.\r
 \r
-  @return The value written to the Mmio. It equals to the input\r
-          Value instead of the actual value read back from the\r
-          Mmio.\r
 **/\r
 UINT8\r
 EFIAPI\r
@@ -81,10 +80,11 @@ MmioWrite8 (
   operations are serialized.\r
 \r
   If 16-bit MMIO register operations are not supported, then ASSERT().\r
+  If Address is not aligned on a 16-bit boundary, then ASSERT().\r
 \r
   @param  Address The MMIO register to read.\r
 \r
-  @return The value read from Address.\r
+  @return The value read.\r
 \r
 **/\r
 UINT16\r
@@ -105,13 +105,13 @@ MmioRead16 (
   and write operations are serialized.\r
 \r
   If 16-bit MMIO register operations are not supported, then ASSERT().\r
+  If Address is not aligned on a 16-bit boundary, then ASSERT().\r
 \r
   @param  Address The MMIO register to write.\r
   @param  Value   The value to write to the MMIO register.\r
+  \r
+  @return Value.\r
 \r
-  @return The value written to the Mmio. It equals to the input\r
-          Value instead of the actual value read back from the\r
-          Mmio.\r
 **/\r
 UINT16\r
 EFIAPI\r
@@ -132,10 +132,11 @@ MmioWrite16 (
   operations are serialized.\r
 \r
   If 32-bit MMIO register operations are not supported, then ASSERT().\r
+  If Address is not aligned on a 32-bit boundary, then ASSERT().\r
 \r
   @param  Address The MMIO register to read.\r
 \r
-  @return The value read from Address.\r
+  @return The value read.\r
 \r
 **/\r
 UINT32\r
@@ -156,13 +157,13 @@ MmioRead32 (
   and write operations are serialized.\r
 \r
   If 32-bit MMIO register operations are not supported, then ASSERT().\r
+  If Address is not aligned on a 32-bit boundary, then ASSERT().\r
 \r
   @param  Address The MMIO register to write.\r
   @param  Value   The value to write to the MMIO register.\r
+  \r
+  @return Value.\r
 \r
-  @return The value written to the Mmio. It equals to the input\r
-          Value instead of the actual value read back from the\r
-          Mmio.\r
 **/\r
 UINT32\r
 EFIAPI\r
@@ -183,10 +184,11 @@ MmioWrite32 (
   operations are serialized.\r
 \r
   If 64-bit MMIO register operations are not supported, then ASSERT().\r
+  If Address is not aligned on a 64-bit boundary, then ASSERT().\r
 \r
   @param  Address The MMIO register to read.\r
 \r
-  @return The value read from Address.\r
+  @return The value read.\r
 \r
 **/\r
 UINT64\r
@@ -207,13 +209,11 @@ MmioRead64 (
   and write operations are serialized.\r
 \r
   If 64-bit MMIO register operations are not supported, then ASSERT().\r
+  If Address is not aligned on a 64-bit boundary, then ASSERT().\r
 \r
   @param  Address The MMIO register to write.\r
   @param  Value   The value to write to the MMIO register.\r
 \r
-  @return The value written to the Mmio. It equals to the input\r
-          Value instead of the actual value read back from the\r
-          Mmio.\r
 **/\r
 UINT64\r
 EFIAPI\r
@@ -243,6 +243,20 @@ MmioWrite64 (
 \r
 **/\r
 __inline__\r
+/**\r
+  Reads an 8-bit I/O port.\r
+\r
+  Reads the 8-bit I/O port specified by Port. The 8-bit read value is returned.\r
+  This function must guarantee that all I/O read and write operations are\r
+  serialized.\r
+\r
+  If 8-bit I/O port operations are not supported, then ASSERT().\r
+\r
+  @param  Port  The I/O port to read.\r
+\r
+  @return The value read.\r
+\r
+**/\r
 UINT8\r
 EFIAPI\r
 IoRead8 (\r
@@ -273,6 +287,21 @@ IoRead8 (
 \r
 **/\r
 __inline__\r
+/**\r
+  Writes an 8-bit I/O port.\r
+\r
+  Writes the 8-bit I/O port specified by Port with the value specified by Value\r
+  and returns Value. This function must guarantee that all I/O read and write\r
+  operations are serialized.\r
+\r
+  If 8-bit I/O port operations are not supported, then ASSERT().\r
+\r
+  @param  Port  The I/O port to write.\r
+  @param  Value The value to write to the I/O port.\r
+\r
+  @return The value written the I/O port.\r
+\r
+**/\r
 UINT8\r
 EFIAPI\r
 IoWrite8 (\r
@@ -299,6 +328,21 @@ IoWrite8 (
 \r
 **/\r
 __inline__\r
+/**\r
+  Reads a 16-bit I/O port.\r
+\r
+  Reads the 16-bit I/O port specified by Port. The 16-bit read value is returned.\r
+  This function must guarantee that all I/O read and write operations are\r
+  serialized.\r
+\r
+  If 16-bit I/O port operations are not supported, then ASSERT().\r
+  If Port is not aligned on a 16-bit boundary, then ASSERT().\r
+\r
+  @param  Port  The I/O port to read.\r
+\r
+  @return The value read.\r
+\r
+**/\r
 UINT16\r
 EFIAPI\r
 IoRead16 (\r
@@ -330,6 +374,22 @@ IoRead16 (
 \r
 **/\r
 __inline__\r
+/**\r
+  Writes a 16-bit I/O port.\r
+\r
+  Writes the 16-bit I/O port specified by Port with the value specified by Value\r
+  and returns Value. This function must guarantee that all I/O read and write\r
+  operations are serialized.\r
+\r
+  If 16-bit I/O port operations are not supported, then ASSERT().\r
+  If Port is not aligned on a 16-bit boundary, then ASSERT().\r
+  \r
+  @param  Port  The I/O port to write.\r
+  @param  Value The value to write to the I/O port.\r
+\r
+  @return The value written the I/O port.\r
+\r
+**/\r
 UINT16\r
 EFIAPI\r
 IoWrite16 (\r
@@ -357,6 +417,21 @@ IoWrite16 (
 \r
 **/\r
 __inline__\r
+/**\r
+  Reads a 32-bit I/O port.\r
+\r
+  Reads the 32-bit I/O port specified by Port. The 32-bit read value is returned.\r
+  This function must guarantee that all I/O read and write operations are\r
+  serialized.\r
+\r
+  If 32-bit I/O port operations are not supported, then ASSERT().\r
+  If Port is not aligned on a 32-bit boundary, then ASSERT().\r
+  \r
+  @param  Port  The I/O port to read.\r
+\r
+  @return The value read.\r
+\r
+**/\r
 UINT32\r
 EFIAPI\r
 IoRead32 (\r
@@ -388,11 +463,27 @@ IoRead32 (
 \r
 **/\r
 __inline__\r
+/**\r
+  Writes a 32-bit I/O port.\r
+\r
+  Writes the 32-bit I/O port specified by Port with the value specified by Value\r
+  and returns Value. This function must guarantee that all I/O read and write\r
+  operations are serialized.\r
+\r
+  If 32-bit I/O port operations are not supported, then ASSERT().\r
+  If Port is not aligned on a 32-bit boundary, then ASSERT().\r
+  \r
+  @param  Port  The I/O port to write.\r
+  @param  Value The value to write to the I/O port.\r
+\r
+  @return The value written the I/O port.\r
+\r
+**/\r
 UINT32\r
 EFIAPI\r
 IoWrite32 (\r
   IN      UINTN                     Port,\r
-  IN      UINT32  Value\r
+  IN      UINT32                    Value\r
   )\r
 {\r
   ASSERT ((Port & 3) == 0);\r
index 0d4ee407244aabe2fc3cdbf6579ebbc536c7d42f..bfd9d031060ce67c725b6a73f65ac63f0a7dde22 100644 (file)
@@ -26,7 +26,7 @@
 \r
   @param  Address The MMIO register to read.\r
 \r
-  @return The value read from Address.\r
+  @return The value read.\r
 \r
 **/\r
 UINT8\r
@@ -50,9 +50,7 @@ MmioRead8 (
   @param  Address The MMIO register to write.\r
   @param  Value   The value to write to the MMIO register.\r
   \r
-  @return The value written to the Mmio. It equals to the input\r
-          Value instead of the actual value read back from the\r
-          Mmio.\r
+  @return Value.\r
 \r
 **/\r
 UINT8\r
@@ -73,10 +71,11 @@ MmioWrite8 (
   operations are serialized.\r
 \r
   If 16-bit MMIO register operations are not supported, then ASSERT().\r
+  If Address is not aligned on a 16-bit boundary, then ASSERT().\r
 \r
   @param  Address The MMIO register to read.\r
 \r
-  @return The value read from Address.\r
+  @return The value read.\r
 \r
 **/\r
 UINT16\r
@@ -97,13 +96,12 @@ MmioRead16 (
   and write operations are serialized.\r
 \r
   If 16-bit MMIO register operations are not supported, then ASSERT().\r
+  If Address is not aligned on a 16-bit boundary, then ASSERT().\r
 \r
   @param  Address The MMIO register to write.\r
   @param  Value   The value to write to the MMIO register.\r
   \r
-  @return The value written to the Mmio. It equals to the input\r
-          Value instead of the actual value read back from the\r
-          Mmio.\r
+  @return Value.\r
 \r
 **/\r
 UINT16\r
@@ -125,10 +123,11 @@ MmioWrite16 (
   operations are serialized.\r
 \r
   If 32-bit MMIO register operations are not supported, then ASSERT().\r
+  If Address is not aligned on a 32-bit boundary, then ASSERT().\r
 \r
   @param  Address The MMIO register to read.\r
 \r
-  @return The value read from Address.\r
+  @return The value read.\r
 \r
 **/\r
 UINT32\r
@@ -149,13 +148,12 @@ MmioRead32 (
   and write operations are serialized.\r
 \r
   If 32-bit MMIO register operations are not supported, then ASSERT().\r
+  If Address is not aligned on a 32-bit boundary, then ASSERT().\r
 \r
   @param  Address The MMIO register to write.\r
   @param  Value   The value to write to the MMIO register.\r
   \r
-  @return The value written to the Mmio. It equals to the input\r
-          Value instead of the actual value read back from the\r
-          Mmio.\r
+  @return Value.\r
 \r
 **/\r
 UINT32\r
@@ -177,10 +175,11 @@ MmioWrite32 (
   operations are serialized.\r
 \r
   If 64-bit MMIO register operations are not supported, then ASSERT().\r
+  If Address is not aligned on a 64-bit boundary, then ASSERT().\r
 \r
   @param  Address The MMIO register to read.\r
 \r
-  @return The value read from Address.\r
+  @return The value read.\r
 \r
 **/\r
 UINT64\r
@@ -201,13 +200,11 @@ MmioRead64 (
   and write operations are serialized.\r
 \r
   If 64-bit MMIO register operations are not supported, then ASSERT().\r
+  If Address is not aligned on a 64-bit boundary, then ASSERT().\r
 \r
   @param  Address The MMIO register to write.\r
   @param  Value   The value to write to the MMIO register.\r
 \r
-  @return The value written to the Mmio. It equals to the input\r
-          Value instead of the actual value read back from the\r
-          Mmio.\r
 **/\r
 UINT64\r
 EFIAPI\r
@@ -233,7 +230,7 @@ MmioWrite64 (
 \r
   @param  Port  The I/O port to read.\r
 \r
-  @return The value read from Port.\r
+  @return The value read.\r
 \r
 **/\r
 UINT8\r
@@ -265,9 +262,7 @@ IoRead8 (
   @param  Port  The I/O port to write.\r
   @param  Value The value to write to the I/O port.\r
 \r
-  @return The value written to the I/O port. It equals to the input\r
-          Value instead of the actual value read back from the\r
-          I/O port.\r
+  @return The value written the I/O port.\r
 \r
 **/\r
 UINT8\r
@@ -293,10 +288,11 @@ IoWrite8 (
   serialized.\r
 \r
   If 16-bit I/O port operations are not supported, then ASSERT().\r
+  If Port is not aligned on a 16-bit boundary, then ASSERT().\r
 \r
   @param  Port  The I/O port to read.\r
 \r
-  @return The value read from Port.\r
+  @return The value read.\r
 \r
 **/\r
 UINT16\r
@@ -326,13 +322,12 @@ IoRead16 (
   operations are serialized.\r
 \r
   If 16-bit I/O port operations are not supported, then ASSERT().\r
-\r
+  If Port is not aligned on a 16-bit boundary, then ASSERT().\r
+  \r
   @param  Port  The I/O port to write.\r
   @param  Value The value to write to the I/O port.\r
 \r
-  @return The value written to the I/O port. It equals to the input\r
-          Value instead of the actual value read back from the\r
-          I/O port.\r
+  @return The value written the I/O port.\r
 \r
 **/\r
 UINT16\r
@@ -361,10 +356,11 @@ IoWrite16 (
   serialized.\r
 \r
   If 32-bit I/O port operations are not supported, then ASSERT().\r
-\r
+  If Port is not aligned on a 32-bit boundary, then ASSERT().\r
+  \r
   @param  Port  The I/O port to read.\r
 \r
-  @return The value read from Port.\r
+  @return The value read.\r
 \r
 **/\r
 UINT32\r
@@ -394,20 +390,19 @@ IoRead32 (
   operations are serialized.\r
 \r
   If 32-bit I/O port operations are not supported, then ASSERT().\r
-\r
+  If Port is not aligned on a 32-bit boundary, then ASSERT().\r
+  \r
   @param  Port  The I/O port to write.\r
   @param  Value The value to write to the I/O port.\r
 \r
-  @return The value written to the I/O port. It equals to the input\r
-          Value instead of the actual value read back from the\r
-          I/O port.\r
+  @return The value written the I/O port.\r
 \r
 **/\r
 UINT32\r
 EFIAPI\r
 IoWrite32 (\r
-  IN      UINTN   Port,\r
-  IN      UINT32  Value\r
+  IN      UINTN                     Port,\r
+  IN      UINT32                    Value\r
   )\r
 {\r
   ASSERT ((Port & 3) == 0);\r
index 7a5a4464aa5c415662ab3922174dccd8a03dac01..919b56aa73a4a81710352a4993f73b24c74db93d 100644 (file)
@@ -52,21 +52,23 @@ InternalGetMemoryMapAddress (
 }\r
 \r
 /**\r
-  Reads a 8-bit I/O port.\r
+  Reads an 8-bit I/O port.\r
 \r
   Reads the 8-bit I/O port specified by Port. The 8-bit read value is returned.\r
   This function must guarantee that all I/O read and write operations are\r
   serialized.\r
 \r
+  If 8-bit I/O port operations are not supported, then ASSERT().\r
+\r
   @param  Port  The I/O port to read.\r
 \r
-  @return The value read from Port.\r
+  @return The value read.\r
 \r
 **/\r
 UINT8\r
 EFIAPI\r
 IoRead8 (\r
-  IN  UINTN                  Port\r
+  IN      UINTN                     Port\r
   )\r
 {\r
   return MmioRead8 (InternalGetMemoryMapAddress (Port));\r
@@ -79,15 +81,18 @@ IoRead8 (
   This function must guarantee that all I/O read and write operations are\r
   serialized.\r
 \r
+  If 16-bit I/O port operations are not supported, then ASSERT().\r
+  If Port is not aligned on a 16-bit boundary, then ASSERT().\r
+\r
   @param  Port  The I/O port to read.\r
 \r
-  @return The value read from Port.\r
+  @return The value read.\r
 \r
 **/\r
 UINT16\r
 EFIAPI\r
 IoRead16 (\r
-  IN  UINTN                  Port\r
+  IN      UINTN                     Port\r
   )\r
 {\r
   return MmioRead16 (InternalGetMemoryMapAddress (Port));\r
@@ -100,15 +105,18 @@ IoRead16 (
   This function must guarantee that all I/O read and write operations are\r
   serialized.\r
 \r
+  If 32-bit I/O port operations are not supported, then ASSERT().\r
+  If Port is not aligned on a 32-bit boundary, then ASSERT().\r
+  \r
   @param  Port  The I/O port to read.\r
 \r
-  @return The value read from Port.\r
+  @return The value read.\r
 \r
 **/\r
 UINT32\r
 EFIAPI\r
 IoRead32 (\r
-  IN  UINTN                  Port\r
+  IN      UINTN                     Port\r
   )\r
 {\r
   return MmioRead32 (InternalGetMemoryMapAddress (Port));\r
@@ -122,10 +130,11 @@ IoRead32 (
   serialized.\r
 \r
   If 64-bit I/O port operations are not supported, then ASSERT().\r
+  If Port is not aligned on a 64-bit boundary, then ASSERT().\r
 \r
   @param  Port  The I/O port to read.\r
 \r
-  @return The value read from Port.\r
+  @return The value read.\r
 \r
 **/\r
 UINT64\r
@@ -139,28 +148,28 @@ IoRead64 (
 }\r
 \r
 /**\r
-  Writes a 8-bit I/O port.\r
+  Writes an 8-bit I/O port.\r
 \r
   Writes the 8-bit I/O port specified by Port with the value specified by Value\r
   and returns Value. This function must guarantee that all I/O read and write\r
   operations are serialized.\r
 \r
+  If 8-bit I/O port operations are not supported, then ASSERT().\r
+\r
   @param  Port  The I/O port to write.\r
-  @param  Data  The value to write to the I/O port.\r
+  @param  Value The value to write to the I/O port.\r
 \r
-  @return The value written to the I/O port. It equals to the\r
-          input Value instead of the actual value read back from\r
-          the I/O port.\r
+  @return The value written the I/O port.\r
 \r
 **/\r
 UINT8\r
 EFIAPI\r
 IoWrite8 (\r
-  IN  UINTN                  Port,\r
-  IN  UINT8                  Data\r
+  IN      UINTN                     Port,\r
+  IN      UINT8                     Value\r
   )\r
 {\r
-  return MmioWrite8 (InternalGetMemoryMapAddress (Port), Data);\r
+  return MmioWrite8 (InternalGetMemoryMapAddress (Port), Value);\r
 }\r
 \r
 /**\r
@@ -170,22 +179,23 @@ IoWrite8 (
   and returns Value. This function must guarantee that all I/O read and write\r
   operations are serialized.\r
 \r
+  If 16-bit I/O port operations are not supported, then ASSERT().\r
+  If Port is not aligned on a 16-bit boundary, then ASSERT().\r
+  \r
   @param  Port  The I/O port to write.\r
-  @param  Data  The value to write to the I/O port.\r
+  @param  Value The value to write to the I/O port.\r
 \r
-  @return The value written to the I/O port. It equals to the\r
-          input Value instead of the actual value read back from\r
-          the I/O port.\r
+  @return The value written the I/O port.\r
 \r
 **/\r
 UINT16\r
 EFIAPI\r
 IoWrite16 (\r
-  IN  UINTN                  Port,\r
-  IN  UINT16                 Data\r
+  IN      UINTN                     Port,\r
+  IN      UINT16                    Value\r
   )\r
 {\r
-  return MmioWrite16 (InternalGetMemoryMapAddress (Port), Data);\r
+  return MmioWrite16 (InternalGetMemoryMapAddress (Port), Value);\r
 }\r
 \r
 /**\r
@@ -195,22 +205,23 @@ IoWrite16 (
   and returns Value. This function must guarantee that all I/O read and write\r
   operations are serialized.\r
 \r
+  If 32-bit I/O port operations are not supported, then ASSERT().\r
+  If Port is not aligned on a 32-bit boundary, then ASSERT().\r
+  \r
   @param  Port  The I/O port to write.\r
-  @param  Data  The value to write to the I/O port.\r
+  @param  Value The value to write to the I/O port.\r
 \r
-  @return The value written to the I/O port. It equals to the\r
-          input Value instead of the actual value read back from\r
-          the I/O port.\r
+  @return The value written the I/O port.\r
 \r
 **/\r
 UINT32\r
 EFIAPI\r
 IoWrite32 (\r
-  IN  UINTN                  Port,\r
-  IN  UINT32                 Data\r
+  IN      UINTN                     Port,\r
+  IN      UINT32                    Value\r
   )\r
 {\r
-  return MmioWrite32 (InternalGetMemoryMapAddress (Port), Data);\r
+  return MmioWrite32 (InternalGetMemoryMapAddress (Port), Value);\r
 }\r
 \r
 /**\r
@@ -221,13 +232,12 @@ IoWrite32 (
   operations are serialized.\r
 \r
   If 64-bit I/O port operations are not supported, then ASSERT().\r
+  If Port is not aligned on a 64-bit boundary, then ASSERT().\r
 \r
   @param  Port  The I/O port to write.\r
   @param  Value The value to write to the I/O port.\r
 \r
-  @return The value written to the I/O port. It equals to the\r
-          input Value instead of the actual value read back from\r
-          the I/O port.\r
+  @return The value written the I/O port.\r
 \r
 **/\r
 UINT64\r
@@ -242,21 +252,23 @@ IoWrite64 (
 }\r
 \r
 /**\r
-  Reads a 8-bit MMIO register.\r
+  Reads an 8-bit MMIO register.\r
 \r
   Reads the 8-bit MMIO register specified by Address. The 8-bit read value is\r
   returned. This function must guarantee that all MMIO read and write\r
   operations are serialized.\r
 \r
+  If 8-bit MMIO register operations are not supported, then ASSERT().\r
+\r
   @param  Address The MMIO register to read.\r
 \r
-  @return The value read from Address.\r
+  @return The value read.\r
 \r
 **/\r
 UINT8\r
 EFIAPI\r
 MmioRead8 (\r
-  IN  UINTN                  Address\r
+  IN      UINTN                     Address\r
   )\r
 {\r
   UINT8            Data;\r
@@ -277,15 +289,18 @@ MmioRead8 (
   returned. This function must guarantee that all MMIO read and write\r
   operations are serialized.\r
 \r
+  If 16-bit MMIO register operations are not supported, then ASSERT().\r
+  If Address is not aligned on a 16-bit boundary, then ASSERT().\r
+\r
   @param  Address The MMIO register to read.\r
 \r
-  @return The value read from Address.\r
+  @return The value read.\r
 \r
 **/\r
 UINT16\r
 EFIAPI\r
 MmioRead16 (\r
-  IN  UINTN                  Address\r
+  IN      UINTN                     Address\r
   )\r
 {\r
   UINT16           Data;\r
@@ -311,15 +326,18 @@ MmioRead16 (
   returned. This function must guarantee that all MMIO read and write\r
   operations are serialized.\r
 \r
+  If 32-bit MMIO register operations are not supported, then ASSERT().\r
+  If Address is not aligned on a 32-bit boundary, then ASSERT().\r
+\r
   @param  Address The MMIO register to read.\r
 \r
-  @return The value read from Address.\r
+  @return The value read.\r
 \r
 **/\r
 UINT32\r
 EFIAPI\r
 MmioRead32 (\r
-  IN  UINTN                  Address\r
+  IN      UINTN                     Address\r
   )\r
 {\r
   UINT32           Data;\r
@@ -345,15 +363,18 @@ MmioRead32 (
   returned. This function must guarantee that all MMIO read and write\r
   operations are serialized.\r
 \r
+  If 64-bit MMIO register operations are not supported, then ASSERT().\r
+  If Address is not aligned on a 64-bit boundary, then ASSERT().\r
+\r
   @param  Address The MMIO register to read.\r
 \r
-  @return The value read from Address.\r
+  @return The value read.\r
 \r
 **/\r
 UINT64\r
 EFIAPI\r
 MmioRead64 (\r
-  IN  UINTN                  Address\r
+  IN      UINTN                     Address\r
   )\r
 {\r
   UINT64           Data;\r
@@ -374,34 +395,34 @@ MmioRead64 (
 }\r
 \r
 /**\r
-  Writes a 8-bit MMIO register.\r
+  Writes an 8-bit MMIO register.\r
 \r
   Writes the 8-bit MMIO register specified by Address with the value specified\r
   by Value and returns Value. This function must guarantee that all MMIO read\r
   and write operations are serialized.\r
 \r
-  @param  Address The MMIO register to write.\r
-  @param  Data    The value to write to the MMIO register.\r
+  If 8-bit MMIO register operations are not supported, then ASSERT().\r
 \r
-  @return The value written to the Mmio. It equals to the\r
-          input Value instead of the actual value read back from\r
-          the Mmio.\r
+  @param  Address The MMIO register to write.\r
+  @param  Value   The value to write to the MMIO register.\r
+  \r
+  @return Value.\r
 \r
 **/\r
 UINT8\r
 EFIAPI\r
 MmioWrite8 (\r
-  IN  UINTN                  Address,\r
-  IN  UINT8                  Data\r
+  IN      UINTN                     Address,\r
+  IN      UINT8                     Value\r
   )\r
 {\r
   Address |= BIT63;\r
 \r
   MemoryFence ();\r
-  *((volatile UINT8 *) Address) = Data;\r
+  *((volatile UINT8 *) Address) = Value;\r
   MemoryFence ();\r
 \r
-  return Data;\r
+  return Value;\r
 }\r
 \r
 /**\r
@@ -411,19 +432,20 @@ MmioWrite8 (
   by Value and returns Value. This function must guarantee that all MMIO read\r
   and write operations are serialized.\r
 \r
-  @param  Address The MMIO register to write.\r
-  @param  Data    The value to write to the MMIO register.\r
+  If 16-bit MMIO register operations are not supported, then ASSERT().\r
+  If Address is not aligned on a 16-bit boundary, then ASSERT().\r
 \r
-  @return The value written to the Mmio. It equals to the\r
-          input Value instead of the actual value read back from\r
-          the Mmio.\r
+  @param  Address The MMIO register to write.\r
+  @param  Value   The value to write to the MMIO register.\r
+  \r
+  @return Value.\r
 \r
 **/\r
 UINT16\r
 EFIAPI\r
 MmioWrite16 (\r
-  IN  UINTN                  Address,\r
-  IN  UINT16                 Data\r
+  IN      UINTN                     Address,\r
+  IN      UINT16                    Value\r
   )\r
 {\r
   //\r
@@ -434,10 +456,10 @@ MmioWrite16 (
   Address |= BIT63;\r
 \r
   MemoryFence ();\r
-  *((volatile UINT16 *) Address) = Data;\r
+  *((volatile UINT16 *) Address) = Value;\r
   MemoryFence ();\r
 \r
-  return Data;\r
+  return Value;\r
 }\r
 \r
 /**\r
@@ -447,19 +469,20 @@ MmioWrite16 (
   by Value and returns Value. This function must guarantee that all MMIO read\r
   and write operations are serialized.\r
 \r
-  @param  Address The MMIO register to write.\r
-  @param  Data    The value to write to the MMIO register.\r
+  If 32-bit MMIO register operations are not supported, then ASSERT().\r
+  If Address is not aligned on a 32-bit boundary, then ASSERT().\r
 \r
-  @return The value written to the Mmio. It equals to the\r
-          input Value instead of the actual value read back from\r
-          the Mmio.\r
+  @param  Address The MMIO register to write.\r
+  @param  Value   The value to write to the MMIO register.\r
+  \r
+  @return Value.\r
 \r
 **/\r
 UINT32\r
 EFIAPI\r
 MmioWrite32 (\r
-  IN  UINTN                  Address,\r
-  IN  UINT32                 Data\r
+  IN      UINTN                     Address,\r
+  IN      UINT32                    Value\r
   )\r
 {\r
   //\r
@@ -470,10 +493,10 @@ MmioWrite32 (
   Address |= BIT63;\r
 \r
   MemoryFence ();\r
-  *((volatile UINT32 *) Address) = Data;\r
+  *((volatile UINT32 *) Address) = Value;\r
   MemoryFence ();\r
 \r
-  return Data;\r
+  return Value;\r
 }\r
 \r
 /**\r
@@ -483,19 +506,18 @@ MmioWrite32 (
   by Value and returns Value. This function must guarantee that all MMIO read\r
   and write operations are serialized.\r
 \r
-  @param  Address The MMIO register to write.\r
-  @param  Data    The value to write to the MMIO register.\r
+  If 64-bit MMIO register operations are not supported, then ASSERT().\r
+  If Address is not aligned on a 64-bit boundary, then ASSERT().\r
 \r
-  @return The value written to the Mmio. It equals to the\r
-          input Value instead of the actual value read back from\r
-          the Mmio.\r
+  @param  Address The MMIO register to write.\r
+  @param  Value   The value to write to the MMIO register.\r
 \r
 **/\r
 UINT64\r
 EFIAPI\r
 MmioWrite64 (\r
-  IN  UINTN                  Address,\r
-  IN  UINT64                 Data\r
+  IN      UINTN                     Address,\r
+  IN      UINT64                    Value\r
   )\r
 {\r
   //\r
@@ -506,8 +528,8 @@ MmioWrite64 (
   Address |= BIT63;\r
 \r
   MemoryFence ();\r
-  *((volatile UINT64 *) Address) = Data;\r
+  *((volatile UINT64 *) Address) = Value;\r
   MemoryFence ();\r
 \r
-  return Data;\r
+  return Value;\r
 }\r
index d6ff0ba01185f613a9e5a1308d6366b6bb914c36..35829cede8a8ba0a41fde724dd6e98b29885274d 100644 (file)
 \r
 \r
   @param  StartAddress    Starting address for the MMIO region to be copied from.\r
-  @param  Length          Size in bytes of the copy.\r
+  @param  Length          The size, in bytes, of Buffer.\r
   @param  Buffer          Pointer to a system memory buffer receiving the data read.\r
 \r
-  @return Buffer contains the data read from Mmio.\r
+  @return Buffer\r
 \r
 **/\r
 UINT8 *\r
@@ -70,10 +70,10 @@ MmioReadBuffer8 (
   If Buffer is not aligned on a 16-bit boundary, then ASSERT().\r
 \r
   @param  StartAddress    Starting address for the MMIO region to be copied from.\r
-  @param  Length          Size in bytes of the copy.\r
+  @param  Length          The size, in bytes, of Buffer.\r
   @param  Buffer          Pointer to a system memory buffer receiving the data read.\r
 \r
-  @return Buffer contains the data read from Mmio.\r
+  @return Buffer\r
 \r
 **/\r
 UINT16 *\r
@@ -121,10 +121,10 @@ MmioReadBuffer16 (
   If Buffer is not aligned on a 32-bit boundary, then ASSERT().\r
 \r
   @param  StartAddress    Starting address for the MMIO region to be copied from.\r
-  @param  Length          Size in bytes of the copy.\r
+  @param  Length          The size, in bytes, of Buffer.\r
   @param  Buffer          Pointer to a system memory buffer receiving the data read.\r
 \r
-  @return Buffer contains the data read from Mmio.\r
+  @return Buffer\r
 \r
 **/\r
 UINT32 *\r
@@ -172,10 +172,10 @@ MmioReadBuffer32 (
   If Buffer is not aligned on a 64-bit boundary, then ASSERT().\r
 \r
   @param  StartAddress    Starting address for the MMIO region to be copied from.\r
-  @param  Length          Size in bytes of the copy.\r
+  @param  Length          The size, in bytes, of Buffer.\r
   @param  Buffer          Pointer to a system memory buffer receiving the data read.\r
 \r
-  @return Buffer contains the data read from Mmio.\r
+  @return Buffer\r
 \r
 **/\r
 UINT64 *\r
@@ -220,7 +220,7 @@ MmioReadBuffer64 (
 \r
 \r
   @param  StartAddress    Starting address for the MMIO region to be copied to.\r
-  @param  Length          Size in bytes of the copy.\r
+  @param  Length          The size, in bytes, of Buffer.\r
   @param  Buffer          Pointer to a system memory buffer containing the data to write.\r
 \r
   @return Size in bytes of the copy.\r
@@ -266,7 +266,7 @@ MmioWriteBuffer8 (
   If Buffer is not aligned on a 16-bit boundary, then ASSERT().\r
 \r
   @param  StartAddress    Starting address for the MMIO region to be copied to.\r
-  @param  Length          Size in bytes of the copy.\r
+  @param  Length          The size, in bytes, of Buffer.\r
   @param  Buffer          Pointer to a system memory buffer containing the data to write.\r
 \r
   @return Size in bytes of the copy.\r
@@ -320,7 +320,7 @@ MmioWriteBuffer16 (
   If Buffer is not aligned on a 32-bit boundary, then ASSERT().\r
 \r
   @param  StartAddress    Starting address for the MMIO region to be copied to.\r
-  @param  Length          Size in bytes of the copy.\r
+  @param  Length          The size, in bytes, of Buffer.\r
   @param  Buffer          Pointer to a system memory buffer containing the data to write.\r
 \r
   @return Size in bytes of the copy.\r
@@ -373,7 +373,7 @@ MmioWriteBuffer32 (
   If Buffer is not aligned on a 64-bit boundary, then ASSERT().\r
 \r
   @param  StartAddress    Starting address for the MMIO region to be copied to.\r
-  @param  Length          Size in bytes of the copy.\r
+  @param  Length          The size, in bytes, of Buffer.\r
   @param  Buffer          Pointer to a system memory buffer containing the data to write.\r
 \r
   @return Size in bytes of the copy.\r
index 7973d4f3d8b75249ac76f671a9249eea5fc3d7dc..e982fa0058005265ae83fcdac8eed91327be21fd 100644 (file)
@@ -62,7 +62,7 @@ void          _ReadWriteBarrier (void);
 \r
   @param  Port  The I/O port to read.\r
 \r
-  @return The value read from Port.\r
+  @return The value read.\r
 \r
 **/\r
 UINT8\r
@@ -115,10 +115,11 @@ IoWrite8 (
   serialized.\r
 \r
   If 16-bit I/O port operations are not supported, then ASSERT().\r
+  If Port is not aligned on a 16-bit boundary, then ASSERT().\r
 \r
   @param  Port  The I/O port to read.\r
 \r
-  @return The value read from Port.\r
+  @return The value read.\r
 \r
 **/\r
 UINT16\r
@@ -144,7 +145,8 @@ IoRead16 (
   operations are serialized.\r
 \r
   If 16-bit I/O port operations are not supported, then ASSERT().\r
-\r
+  If Port is not aligned on a 16-bit boundary, then ASSERT().\r
+  \r
   @param  Port  The I/O port to write.\r
   @param  Value The value to write to the I/O port.\r
 \r
@@ -173,10 +175,11 @@ IoWrite16 (
   serialized.\r
 \r
   If 32-bit I/O port operations are not supported, then ASSERT().\r
-\r
+  If Port is not aligned on a 32-bit boundary, then ASSERT().\r
+  \r
   @param  Port  The I/O port to read.\r
 \r
-  @return The value read from Port.\r
+  @return The value read.\r
 \r
 **/\r
 UINT32\r
@@ -202,7 +205,8 @@ IoRead32 (
   operations are serialized.\r
 \r
   If 32-bit I/O port operations are not supported, then ASSERT().\r
-\r
+  If Port is not aligned on a 32-bit boundary, then ASSERT().\r
+  \r
   @param  Port  The I/O port to write.\r
   @param  Value The value to write to the I/O port.\r
 \r
@@ -235,7 +239,7 @@ IoWrite32 (
 \r
   @param  Address The MMIO register to read.\r
 \r
-  @return The value read from Address.\r
+  @return The value read.\r
 \r
 **/\r
 UINT8\r
@@ -262,10 +266,8 @@ MmioRead8 (
   @param  Address The MMIO register to write.\r
   @param  Value   The value to write to the MMIO register.\r
   \r
-  @return The value written to the Mmio. It equals to the input\r
-          Value instead of the actual value read back from the\r
-          Mmio.\r
-  \r
+  @return Value.\r
+\r
 **/\r
 UINT8\r
 EFIAPI\r
@@ -285,10 +287,11 @@ MmioWrite8 (
   operations are serialized.\r
 \r
   If 16-bit MMIO register operations are not supported, then ASSERT().\r
+  If Address is not aligned on a 16-bit boundary, then ASSERT().\r
 \r
   @param  Address The MMIO register to read.\r
 \r
-  @return The value read from Address.\r
+  @return The value read.\r
 \r
 **/\r
 UINT16\r
@@ -312,12 +315,12 @@ MmioRead16 (
   and write operations are serialized.\r
 \r
   If 16-bit MMIO register operations are not supported, then ASSERT().\r
+  If Address is not aligned on a 16-bit boundary, then ASSERT().\r
 \r
   @param  Address The MMIO register to write.\r
   @param  Value   The value to write to the MMIO register.\r
   \r
-  @return The value read from the Mmio after wrote specified\r
-          Value.\r
+  @return Value.\r
 \r
 **/\r
 UINT16\r
@@ -339,10 +342,11 @@ MmioWrite16 (
   operations are serialized.\r
 \r
   If 32-bit MMIO register operations are not supported, then ASSERT().\r
+  If Address is not aligned on a 32-bit boundary, then ASSERT().\r
 \r
   @param  Address The MMIO register to read.\r
 \r
-  @return The value read from Address.\r
+  @return The value read.\r
 \r
 **/\r
 UINT32\r
@@ -366,13 +370,12 @@ MmioRead32 (
   and write operations are serialized.\r
 \r
   If 32-bit MMIO register operations are not supported, then ASSERT().\r
+  If Address is not aligned on a 32-bit boundary, then ASSERT().\r
 \r
   @param  Address The MMIO register to write.\r
   @param  Value   The value to write to the MMIO register.\r
   \r
-  @return The value written to the Mmio. It equals to the input\r
-          Value instead of the actual value read back from the\r
-          Mmio.\r
+  @return Value.\r
 \r
 **/\r
 UINT32\r
@@ -394,10 +397,11 @@ MmioWrite32 (
   operations are serialized.\r
 \r
   If 64-bit MMIO register operations are not supported, then ASSERT().\r
+  If Address is not aligned on a 64-bit boundary, then ASSERT().\r
 \r
   @param  Address The MMIO register to read.\r
 \r
-  @return The value read from Address.\r
+  @return The value read.\r
 \r
 **/\r
 UINT64\r
@@ -421,14 +425,11 @@ MmioRead64 (
   and write operations are serialized.\r
 \r
   If 64-bit MMIO register operations are not supported, then ASSERT().\r
+  If Address is not aligned on a 64-bit boundary, then ASSERT().\r
 \r
   @param  Address The MMIO register to write.\r
   @param  Value   The value to write to the MMIO register.\r
 \r
-  @return The value written to the Mmio. It equals to the input\r
-          Value instead of the actual value read back from the\r
-          Mmio.\r
-  \r
 **/\r
 UINT64\r
 EFIAPI\r
index da1067404d22845680f7f2915a30426cdf268b55..abe19c930f59b446f955a3b22a84b59c96e0b155 100644 (file)
@@ -75,7 +75,7 @@ _ModuleEntryPoint (
 \r
 \r
 /**\r
-  Invokes the library destructors fror all dependent libraries and terminates\r
+  Invokes the library destructors for all dependent libraries and terminates\r
   the UEFI Application. \r
 \r
   This function calls ProcessLibraryDestructorList() and the EFI Boot Service Exit()\r
index 4858ed6f7d189227ff53cadcc5e59efcb6c6a4b5..95b6a5969fe9ad46d8f215d991a2c862041bdfb6 100644 (file)
@@ -407,7 +407,7 @@ UsbSetReportRequest (
   Request.Request = EFI_USB_SET_REPORT_REQUEST;\r
   Request.Value   = (UINT16) ((ReportType << 8) | ReportId);\r
   Request.Index   = Interface;\r
-  Request.Length  = ReportLength;\r
+  Request.Length  = ReportLen;\r
 \r
   Result = UsbIo->UsbControlTransfer (\r
                     UsbIo,\r