Synchronize the h files with c files.

[mirror_edk2.git] / MdePkg / Library / BaseIoLibIntrinsic / IoHighLevel.c

diff --git a/MdePkg/Library/BaseIoLibIntrinsic/IoHighLevel.c b/MdePkg/Library/BaseIoLibIntrinsic/IoHighLevel.c
index 344a9faf8bff75aa894584796b2a6d0f1c62e243..ece2f9710204d05d9a342ac8fae19b43def16d0b 100644 (file)
--- a/MdePkg/Library/BaseIoLibIntrinsic/IoHighLevel.c
+++ b/MdePkg/Library/BaseIoLibIntrinsic/IoHighLevel.c
@@ -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