Add ASSERT() for BitField operations to make sure the input value is valid.

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

diff --git a/MdePkg/Library/BaseIoLibIntrinsic/IoHighLevel.c b/MdePkg/Library/BaseIoLibIntrinsic/IoHighLevel.c
index 344a9faf8bff75aa894584796b2a6d0f1c62e243..ab1ddf4c424ef633d521301e02c9686ffbc37bab 100644 (file)
--- a/MdePkg/Library/BaseIoLibIntrinsic/IoHighLevel.c
+++ b/MdePkg/Library/BaseIoLibIntrinsic/IoHighLevel.c
@@ -4,11 +4,11 @@
   All assertions for bit field operations are handled bit field functions in the\r
   Base Library.\r
 \r
-  Copyright (c) 2006 - 2008, Intel Corporation<BR>\r
-  All rights reserved. This program and the accompanying materials\r
+  Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.<BR>\r
+  This program and the accompanying materials\r
   are licensed and made available under the terms and conditions of the BSD License\r
   which accompanies this distribution.  The full text of the license may be found at\r
-  http://opensource.org/licenses/bsd-license.php\r
+  http://opensource.org/licenses/bsd-license.php.\r
 \r
   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
@@ -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
@@ -153,13 +152,14 @@ IoBitFieldRead8 (
   If StartBit is greater than 7, then ASSERT().\r
   If EndBit is greater than 7, then ASSERT().\r
   If EndBit is less than StartBit, then ASSERT().\r
+  If Value is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().\r
 \r
   @param  Port      The I/O port to write.\r
   @param  StartBit  The ordinal of the least significant bit in the bit field.\r
                     Range 0..7.\r
   @param  EndBit    The ordinal of the most significant bit in the bit field.\r
                     Range 0..7.\r
-  @param  Value     New value of the bit field.\r
+  @param  Value     The new value of the bit field.\r
 \r
   @return The value written back to the I/O port.\r
 \r
@@ -187,12 +187,13 @@ IoBitFieldWrite8 (
   between the read result and the value specified by OrData, and writes the\r
   result to the 8-bit I/O port specified by Port. The value written to the I/O\r
   port is returned. This function must guarantee that all I/O read and write\r
-  operations are serialized. Extra left bits in OrData are stripped.\r
+  operations are serialized. Extra bits left in OrData are stripped.\r
 \r
   If 8-bit I/O port operations are not supported, then ASSERT().\r
   If StartBit is greater than 7, then ASSERT().\r
   If EndBit is greater than 7, then ASSERT().\r
   If EndBit is less than StartBit, then ASSERT().\r
+  If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().\r
 \r
   @param  Port      The I/O port to write.\r
   @param  StartBit  The ordinal of the least significant bit in the bit field.\r
@@ -227,12 +228,13 @@ IoBitFieldOr8 (
   the read result and the value specified by AndData, and writes the result to\r
   the 8-bit I/O port specified by Port. The value written to the I/O port is\r
   returned. This function must guarantee that all I/O read and write operations\r
-  are serialized. Extra left bits in AndData are stripped.\r
+  are serialized. Extra bits left in AndData are stripped.\r
 \r
   If 8-bit I/O port operations are not supported, then ASSERT().\r
   If StartBit is greater than 7, then ASSERT().\r
   If EndBit is greater than 7, then ASSERT().\r
   If EndBit is less than StartBit, then ASSERT().\r
+  If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().\r
 \r
   @param  Port      The I/O port to write.\r
   @param  StartBit  The ordinal of the least significant bit in the bit field.\r
@@ -268,13 +270,15 @@ IoBitFieldAnd8 (
   by a bitwise OR between the read result and the value specified by\r
   AndData, and writes the result to the 8-bit I/O port specified by Port. The\r
   value written to the I/O port is returned. This function must guarantee that\r
-  all I/O read and write operations are serialized. Extra left bits in both\r
+  all I/O read and write operations are serialized. Extra bits left in both\r
   AndData and OrData are stripped.\r
 \r
   If 8-bit I/O port operations are not supported, then ASSERT().\r
   If StartBit is greater than 7, then ASSERT().\r
   If EndBit is greater than 7, then ASSERT().\r
   If EndBit is less than StartBit, then ASSERT().\r
+  If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().\r
+  If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().\r
 \r
   @param  Port      The I/O port to write.\r
   @param  StartBit  The ordinal of the least significant bit in the bit field.\r
@@ -314,6 +318,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 +347,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 +377,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 +404,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 +415,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
@@ -428,19 +435,21 @@ IoBitFieldRead16 (
   Writes Value to the bit field of the I/O register. The bit field is specified\r
   by the StartBit and the EndBit. All other bits in the destination I/O\r
   register are preserved. The value written to the I/O port is returned. Extra\r
-  left bits in Value are stripped.\r
+  bits left 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
+  If Value is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().\r
 \r
   @param  Port      The I/O port to write.\r
   @param  StartBit  The ordinal of the least significant bit in the bit field.\r
                     Range 0..15.\r
   @param  EndBit    The ordinal of the most significant bit in the bit field.\r
                     Range 0..15.\r
-  @param  Value     New value of the bit field.\r
+  @param  Value     The new value of the bit field.\r
 \r
   @return The value written back to the I/O port.\r
 \r
@@ -468,12 +477,14 @@ IoBitFieldWrite16 (
   between the read result and the value specified by OrData, and writes the\r
   result to the 16-bit I/O port specified by Port. The value written to the I/O\r
   port is returned. This function must guarantee that all I/O read and write\r
-  operations are serialized. Extra left bits in OrData are stripped.\r
+  operations are serialized. Extra bits left 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
+  If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().\r
 \r
   @param  Port      The I/O port to write.\r
   @param  StartBit  The ordinal of the least significant bit in the bit field.\r
@@ -508,12 +519,14 @@ IoBitFieldOr16 (
   the read result and the value specified by AndData, and writes the result to\r
   the 16-bit I/O port specified by Port. The value written to the I/O port is\r
   returned. This function must guarantee that all I/O read and write operations\r
-  are serialized. Extra left bits in AndData are stripped.\r
+  are serialized. Extra bits left 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
+  If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().\r
 \r
   @param  Port      The I/O port to write.\r
   @param  StartBit  The ordinal of the least significant bit in the bit field.\r
@@ -549,13 +562,16 @@ IoBitFieldAnd16 (
   by a bitwise OR between the read result and the value specified by\r
   AndData, and writes the result to the 16-bit I/O port specified by Port. The\r
   value written to the I/O port is returned. This function must guarantee that\r
-  all I/O read and write operations are serialized. Extra left bits in both\r
+  all I/O read and write operations are serialized. Extra bits left in both\r
   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
+  If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().\r
+  If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().\r
 \r
   @param  Port      The I/O port to write.\r
   @param  StartBit  The ordinal of the least significant bit in the bit field.\r
@@ -595,6 +611,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 +640,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 +670,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 +697,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 +708,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
@@ -709,19 +728,21 @@ IoBitFieldRead32 (
   Writes Value to the bit field of the I/O register. The bit field is specified\r
   by the StartBit and the EndBit. All other bits in the destination I/O\r
   register are preserved. The value written to the I/O port is returned. Extra\r
-  left bits in Value are stripped.\r
+  bits left 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
+  If Value is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().\r
 \r
   @param  Port      The I/O port to write.\r
   @param  StartBit  The ordinal of the least significant bit in the bit field.\r
                     Range 0..31.\r
   @param  EndBit    The ordinal of the most significant bit in the bit field.\r
                     Range 0..31.\r
-  @param  Value     New value of the bit field.\r
+  @param  Value     The new value of the bit field.\r
 \r
   @return The value written back to the I/O port.\r
 \r
@@ -749,12 +770,14 @@ IoBitFieldWrite32 (
   between the read result and the value specified by OrData, and writes the\r
   result to the 32-bit I/O port specified by Port. The value written to the I/O\r
   port is returned. This function must guarantee that all I/O read and write\r
-  operations are serialized. Extra left bits in OrData are stripped.\r
+  operations are serialized. Extra bits left 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
+  If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().\r
 \r
   @param  Port      The I/O port to write.\r
   @param  StartBit  The ordinal of the least significant bit in the bit field.\r
@@ -789,12 +812,14 @@ IoBitFieldOr32 (
   the read result and the value specified by AndData, and writes the result to\r
   the 32-bit I/O port specified by Port. The value written to the I/O port is\r
   returned. This function must guarantee that all I/O read and write operations\r
-  are serialized. Extra left bits in AndData are stripped.\r
+  are serialized. Extra bits left 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
+  If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().\r
 \r
   @param  Port      The I/O port to write.\r
   @param  StartBit  The ordinal of the least significant bit in the bit field.\r
@@ -830,13 +855,16 @@ IoBitFieldAnd32 (
   by a bitwise OR between the read result and the value specified by\r
   AndData, and writes the result to the 32-bit I/O port specified by Port. The\r
   value written to the I/O port is returned. This function must guarantee that\r
-  all I/O read and write operations are serialized. Extra left bits in both\r
+  all I/O read and write operations are serialized. Extra bits left in both\r
   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
+  If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().\r
+  If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().\r
 \r
   @param  Port      The I/O port to write.\r
   @param  StartBit  The ordinal of the least significant bit in the bit field.\r
@@ -876,6 +904,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 +933,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 +963,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 +990,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 +1001,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
@@ -990,19 +1021,21 @@ IoBitFieldRead64 (
   Writes Value to the bit field of the I/O register. The bit field is specified\r
   by the StartBit and the EndBit. All other bits in the destination I/O\r
   register are preserved. The value written to the I/O port is returned. Extra\r
-  left bits in Value are stripped.\r
+  bits left 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
+  If Value is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().\r
 \r
   @param  Port      The I/O port to write.\r
   @param  StartBit  The ordinal of the least significant bit in the bit field.\r
                     Range 0..63.\r
   @param  EndBit    The ordinal of the most significant bit in the bit field.\r
                     Range 0..63.\r
-  @param  Value     New value of the bit field.\r
+  @param  Value     The new value of the bit field.\r
 \r
   @return The value written back to the I/O port.\r
 \r
@@ -1030,12 +1063,14 @@ IoBitFieldWrite64 (
   between the read result and the value specified by OrData, and writes the\r
   result to the 64-bit I/O port specified by Port. The value written to the I/O\r
   port is returned. This function must guarantee that all I/O read and write\r
-  operations are serialized. Extra left bits in OrData are stripped.\r
+  operations are serialized. Extra bits left 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
+  If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().\r
 \r
   @param  Port      The I/O port to write.\r
   @param  StartBit  The ordinal of the least significant bit in the bit field.\r
@@ -1070,12 +1105,14 @@ IoBitFieldOr64 (
   the read result and the value specified by AndData, and writes the result to\r
   the 64-bit I/O port specified by Port. The value written to the I/O port is\r
   returned. This function must guarantee that all I/O read and write operations\r
-  are serialized. Extra left bits in AndData are stripped.\r
+  are serialized. Extra bits left 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
+  If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().\r
 \r
   @param  Port      The I/O port to write.\r
   @param  StartBit  The ordinal of the least significant bit in the bit field.\r
@@ -1111,13 +1148,16 @@ IoBitFieldAnd64 (
   by a bitwise OR between the read result and the value specified by\r
   AndData, and writes the result to the 64-bit I/O port specified by Port. The\r
   value written to the I/O port is returned. This function must guarantee that\r
-  all I/O read and write operations are serialized. Extra left bits in both\r
+  all I/O read and write operations are serialized. Extra bits left in both\r
   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
+  If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().\r
+  If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().\r
 \r
   @param  Port      The I/O port to write.\r
   @param  StartBit  The ordinal of the least significant bit in the bit field.\r
@@ -1245,14 +1285,13 @@ MmioAndThenOr8 (
   If EndBit is greater than 7, then ASSERT().\r
   If EndBit is less than StartBit, then ASSERT().\r
 \r
-  @param  Address   MMIO register to read.\r
+  @param  Address   The MMIO register to read.\r
   @param  StartBit  The ordinal of the least significant bit in the bit field.\r
                     Range 0..7.\r
   @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
@@ -1277,13 +1316,14 @@ MmioBitFieldRead8 (
   If StartBit is greater than 7, then ASSERT().\r
   If EndBit is greater than 7, then ASSERT().\r
   If EndBit is less than StartBit, then ASSERT().\r
+  If Value is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().\r
 \r
-  @param  Address   MMIO register to write.\r
+  @param  Address   The MMIO register to write.\r
   @param  StartBit  The ordinal of the least significant bit in the bit field.\r
                     Range 0..7.\r
   @param  EndBit    The ordinal of the most significant bit in the bit field.\r
                     Range 0..7.\r
-  @param  Value     New value of the bit field.\r
+  @param  Value     The new value of the bit field.\r
 \r
   @return The value written back to the MMIO register.\r
 \r
@@ -1311,15 +1351,16 @@ MmioBitFieldWrite8 (
   OR between the read result and the value specified by OrData, and\r
   writes the result to the 8-bit MMIO register specified by Address. The value\r
   written to the MMIO register is returned. This function must guarantee that\r
-  all MMIO read and write operations are serialized. Extra left bits in OrData\r
+  all MMIO read and write operations are serialized. Extra bits left in OrData\r
   are stripped.\r
 \r
   If 8-bit MMIO register operations are not supported, then ASSERT().\r
   If StartBit is greater than 7, then ASSERT().\r
   If EndBit is greater than 7, then ASSERT().\r
   If EndBit is less than StartBit, then ASSERT().\r
+  If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().\r
 \r
-  @param  Address   MMIO register to write.\r
+  @param  Address   The MMIO register to write.\r
   @param  StartBit  The ordinal of the least significant bit in the bit field.\r
                     Range 0..7.\r
   @param  EndBit    The ordinal of the most significant bit in the bit field.\r
@@ -1352,15 +1393,16 @@ MmioBitFieldOr8 (
   between the read result and the value specified by AndData, and writes the\r
   result to the 8-bit MMIO register specified by Address. The value written to\r
   the MMIO register is returned. This function must guarantee that all MMIO\r
-  read and write operations are serialized. Extra left bits in AndData are\r
+  read and write operations are serialized. Extra bits left in AndData are\r
   stripped.\r
 \r
   If 8-bit MMIO register operations are not supported, then ASSERT().\r
   If StartBit is greater than 7, then ASSERT().\r
   If EndBit is greater than 7, then ASSERT().\r
   If EndBit is less than StartBit, then ASSERT().\r
+  If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().\r
 \r
-  @param  Address   MMIO register to write.\r
+  @param  Address   The MMIO register to write.\r
   @param  StartBit  The ordinal of the least significant bit in the bit field.\r
                     Range 0..7.\r
   @param  EndBit    The ordinal of the most significant bit in the bit field.\r
@@ -1395,14 +1437,16 @@ MmioBitFieldAnd8 (
   specified by AndData, and writes the result to the 8-bit MMIO register\r
   specified by Address. The value written to the MMIO register is returned.\r
   This function must guarantee that all MMIO read and write operations are\r
-  serialized. Extra left bits in both AndData and OrData are stripped.\r
+  serialized. Extra bits left in both AndData and OrData are stripped.\r
 \r
   If 8-bit MMIO register operations are not supported, then ASSERT().\r
   If StartBit is greater than 7, then ASSERT().\r
   If EndBit is greater than 7, then ASSERT().\r
   If EndBit is less than StartBit, then ASSERT().\r
+  If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().\r
+  If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().\r
 \r
-  @param  Address   MMIO register to write.\r
+  @param  Address   The MMIO register to write.\r
   @param  StartBit  The ordinal of the least significant bit in the bit field.\r
                     Range 0..7.\r
   @param  EndBit    The ordinal of the most significant bit in the bit field.\r
@@ -1440,6 +1484,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 +1513,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 +1543,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,18 +1570,18 @@ 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
 \r
-  @param  Address   MMIO register to read.\r
+  @param  Address   The MMIO register to read.\r
   @param  StartBit  The ordinal of the least significant bit in the bit field.\r
                     Range 0..15.\r
   @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,16 +1603,18 @@ 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
+  If Value is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().\r
 \r
-  @param  Address   MMIO register to write.\r
+  @param  Address   The MMIO register to write.\r
   @param  StartBit  The ordinal of the least significant bit in the bit field.\r
                     Range 0..15.\r
   @param  EndBit    The ordinal of the most significant bit in the bit field.\r
                     Range 0..15.\r
-  @param  Value     New value of the bit field.\r
+  @param  Value     The new value of the bit field.\r
 \r
   @return The value written back to the MMIO register.\r
 \r
@@ -1594,15 +1642,17 @@ MmioBitFieldWrite16 (
   OR between the read result and the value specified by OrData, and\r
   writes the result to the 16-bit MMIO register specified by Address. The value\r
   written to the MMIO register is returned. This function must guarantee that\r
-  all MMIO read and write operations are serialized. Extra left bits in OrData\r
+  all MMIO read and write operations are serialized. Extra bits left in OrData\r
   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
+  If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().\r
 \r
-  @param  Address   MMIO register to write.\r
+  @param  Address   The MMIO register to write.\r
   @param  StartBit  The ordinal of the least significant bit in the bit field.\r
                     Range 0..15.\r
   @param  EndBit    The ordinal of the most significant bit in the bit field.\r
@@ -1635,15 +1685,17 @@ MmioBitFieldOr16 (
   between the read result and the value specified by AndData, and writes the\r
   result to the 16-bit MMIO register specified by Address. The value written to\r
   the MMIO register is returned. This function must guarantee that all MMIO\r
-  read and write operations are serialized. Extra left bits in AndData are\r
+  read and write operations are serialized. Extra bits left in AndData are\r
   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
+  If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().\r
 \r
-  @param  Address   MMIO register to write.\r
+  @param  Address   The MMIO register to write.\r
   @param  StartBit  The ordinal of the least significant bit in the bit field.\r
                     Range 0..15.\r
   @param  EndBit    The ordinal of the most significant bit in the bit field.\r
@@ -1678,14 +1730,17 @@ MmioBitFieldAnd16 (
   specified by AndData, and writes the result to the 16-bit MMIO register\r
   specified by Address. The value written to the MMIO register is returned.\r
   This function must guarantee that all MMIO read and write operations are\r
-  serialized. Extra left bits in both AndData and OrData are stripped.\r
+  serialized. Extra bits left 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
+  If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().\r
+  If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().\r
 \r
-  @param  Address   MMIO register to write.\r
+  @param  Address   The MMIO register to write.\r
   @param  StartBit  The ordinal of the least significant bit in the bit field.\r
                     Range 0..15.\r
   @param  EndBit    The ordinal of the most significant bit in the bit field.\r
@@ -1723,6 +1778,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 +1807,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 +1837,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,18 +1864,18 @@ 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
 \r
-  @param  Address   MMIO register to read.\r
+  @param  Address   The MMIO register to read.\r
   @param  StartBit  The ordinal of the least significant bit in the bit field.\r
                     Range 0..31.\r
   @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,16 +1897,18 @@ 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
+  If Value is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().\r
 \r
-  @param  Address   MMIO register to write.\r
+  @param  Address   The MMIO register to write.\r
   @param  StartBit  The ordinal of the least significant bit in the bit field.\r
                     Range 0..31.\r
   @param  EndBit    The ordinal of the most significant bit in the bit field.\r
                     Range 0..31.\r
-  @param  Value     New value of the bit field.\r
+  @param  Value     The new value of the bit field.\r
 \r
   @return The value written back to the MMIO register.\r
 \r
@@ -1877,15 +1936,17 @@ MmioBitFieldWrite32 (
   OR between the read result and the value specified by OrData, and\r
   writes the result to the 32-bit MMIO register specified by Address. The value\r
   written to the MMIO register is returned. This function must guarantee that\r
-  all MMIO read and write operations are serialized. Extra left bits in OrData\r
+  all MMIO read and write operations are serialized. Extra bits left in OrData\r
   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
+  If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().\r
 \r
-  @param  Address   MMIO register to write.\r
+  @param  Address   The MMIO register to write.\r
   @param  StartBit  The ordinal of the least significant bit in the bit field.\r
                     Range 0..31.\r
   @param  EndBit    The ordinal of the most significant bit in the bit field.\r
@@ -1918,15 +1979,17 @@ MmioBitFieldOr32 (
   between the read result and the value specified by AndData, and writes the\r
   result to the 32-bit MMIO register specified by Address. The value written to\r
   the MMIO register is returned. This function must guarantee that all MMIO\r
-  read and write operations are serialized. Extra left bits in AndData are\r
+  read and write operations are serialized. Extra bits left in AndData are\r
   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
+  If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().\r
 \r
-  @param  Address   MMIO register to write.\r
+  @param  Address   The MMIO register to write.\r
   @param  StartBit  The ordinal of the least significant bit in the bit field.\r
                     Range 0..31.\r
   @param  EndBit    The ordinal of the most significant bit in the bit field.\r
@@ -1961,14 +2024,17 @@ MmioBitFieldAnd32 (
   specified by AndData, and writes the result to the 32-bit MMIO register\r
   specified by Address. The value written to the MMIO register is returned.\r
   This function must guarantee that all MMIO read and write operations are\r
-  serialized. Extra left bits in both AndData and OrData are stripped.\r
+  serialized. Extra bits left 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
+  If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().\r
+  If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().\r
 \r
-  @param  Address   MMIO register to write.\r
+  @param  Address   The MMIO register to write.\r
   @param  StartBit  The ordinal of the least significant bit in the bit field.\r
                     Range 0..31.\r
   @param  EndBit    The ordinal of the most significant bit in the bit field.\r
@@ -2006,6 +2072,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 +2101,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 +2131,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,18 +2158,18 @@ 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
 \r
-  @param  Address   MMIO register to read.\r
+  @param  Address   The MMIO register to read.\r
   @param  StartBit  The ordinal of the least significant bit in the bit field.\r
                     Range 0..63.\r
   @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,16 +2191,18 @@ 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
+  If Value is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().\r
 \r
-  @param  Address   MMIO register to write.\r
+  @param  Address   The MMIO register to write.\r
   @param  StartBit  The ordinal of the least significant bit in the bit field.\r
                     Range 0..63.\r
   @param  EndBit    The ordinal of the most significant bit in the bit field.\r
                     Range 0..63.\r
-  @param  Value     New value of the bit field.\r
+  @param  Value     The new value of the bit field.\r
 \r
   @return The value written back to the MMIO register.\r
 \r
@@ -2160,15 +2230,17 @@ MmioBitFieldWrite64 (
   OR between the read result and the value specified by OrData, and\r
   writes the result to the 64-bit MMIO register specified by Address. The value\r
   written to the MMIO register is returned. This function must guarantee that\r
-  all MMIO read and write operations are serialized. Extra left bits in OrData\r
+  all MMIO read and write operations are serialized. Extra bits left in OrData\r
   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
+  If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().\r
 \r
-  @param  Address   MMIO register to write.\r
+  @param  Address   The MMIO register to write.\r
   @param  StartBit  The ordinal of the least significant bit in the bit field.\r
                     Range 0..63.\r
   @param  EndBit    The ordinal of the most significant bit in the bit field.\r
@@ -2201,15 +2273,17 @@ MmioBitFieldOr64 (
   between the read result and the value specified by AndData, and writes the\r
   result to the 64-bit MMIO register specified by Address. The value written to\r
   the MMIO register is returned. This function must guarantee that all MMIO\r
-  read and write operations are serialized. Extra left bits in AndData are\r
+  read and write operations are serialized. Extra bits left in AndData are\r
   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
+  If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().\r
 \r
-  @param  Address   MMIO register to write.\r
+  @param  Address   The MMIO register to write.\r
   @param  StartBit  The ordinal of the least significant bit in the bit field.\r
                     Range 0..63.\r
   @param  EndBit    The ordinal of the most significant bit in the bit field.\r
@@ -2244,14 +2318,17 @@ MmioBitFieldAnd64 (
   specified by AndData, and writes the result to the 64-bit MMIO register\r
   specified by Address. The value written to the MMIO register is returned.\r
   This function must guarantee that all MMIO read and write operations are\r
-  serialized. Extra left bits in both AndData and OrData are stripped.\r
+  serialized. Extra bits left 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
+  If AndData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().\r
+  If OrData is larger than the bitmask value range specified by StartBit and EndBit, then ASSERT().\r
 \r
-  @param  Address   MMIO register to write.\r
+  @param  Address   The MMIO register to write.\r
   @param  StartBit  The ordinal of the least significant bit in the bit field.\r
                     Range 0..63.\r
   @param  EndBit    The ordinal of the most significant bit in the bit field.\r