]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Library/BaseIoLibIntrinsic/IoHighLevel.c
Minor grammatical work--mostly adding periods. Sending separately a list of files...
[mirror_edk2.git] / MdePkg / Library / BaseIoLibIntrinsic / IoHighLevel.c
index 63549a58286ade3ddcafd56d32f458a1598ff0d0..12f9a4183a32104baab5b9b33d414ad7f3e35bf0 100644 (file)
@@ -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. All rights reserved.<BR>\r
+  Copyright (c) 2006 - 2010, 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
@@ -186,7 +186,7 @@ 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
@@ -226,7 +226,7 @@ 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
@@ -267,7 +267,7 @@ 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
@@ -430,7 +430,7 @@ 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
@@ -471,7 +471,7 @@ 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
@@ -512,7 +512,7 @@ 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
@@ -554,7 +554,7 @@ 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
@@ -718,7 +718,7 @@ 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
@@ -759,7 +759,7 @@ 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
@@ -800,7 +800,7 @@ 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
@@ -842,7 +842,7 @@ 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
@@ -1006,7 +1006,7 @@ 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
@@ -1047,7 +1047,7 @@ 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
@@ -1088,7 +1088,7 @@ 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
@@ -1130,7 +1130,7 @@ 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
@@ -1265,7 +1265,7 @@ 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
@@ -1297,7 +1297,7 @@ MmioBitFieldRead8 (
   If EndBit is greater than 7, then ASSERT().\r
   If EndBit is less than StartBit, 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
@@ -1330,7 +1330,7 @@ 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
@@ -1338,7 +1338,7 @@ MmioBitFieldWrite8 (
   If EndBit is greater than 7, then ASSERT().\r
   If EndBit is less than StartBit, 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
@@ -1371,7 +1371,7 @@ 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
@@ -1379,7 +1379,7 @@ MmioBitFieldOr8 (
   If EndBit is greater than 7, then ASSERT().\r
   If EndBit is less than StartBit, 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
@@ -1414,14 +1414,14 @@ 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
 \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
@@ -1550,7 +1550,7 @@ MmioAndThenOr16 (
   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
@@ -1583,7 +1583,7 @@ MmioBitFieldRead16 (
   If EndBit is greater than 15, then ASSERT().\r
   If EndBit is less than StartBit, 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
@@ -1616,7 +1616,7 @@ 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
@@ -1625,7 +1625,7 @@ MmioBitFieldWrite16 (
   If EndBit is greater than 15, then ASSERT().\r
   If EndBit is less than StartBit, 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
@@ -1658,7 +1658,7 @@ 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
@@ -1667,7 +1667,7 @@ MmioBitFieldOr16 (
   If EndBit is greater than 15, then ASSERT().\r
   If EndBit is less than StartBit, 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
@@ -1702,7 +1702,7 @@ 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
@@ -1710,7 +1710,7 @@ MmioBitFieldAnd16 (
   If EndBit is greater than 15, then ASSERT().\r
   If EndBit is less than StartBit, 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
@@ -1839,7 +1839,7 @@ MmioAndThenOr32 (
   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
@@ -1872,7 +1872,7 @@ MmioBitFieldRead32 (
   If EndBit is greater than 31, then ASSERT().\r
   If EndBit is less than StartBit, 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
@@ -1905,7 +1905,7 @@ 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
@@ -1914,7 +1914,7 @@ MmioBitFieldWrite32 (
   If EndBit is greater than 31, then ASSERT().\r
   If EndBit is less than StartBit, 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
@@ -1947,7 +1947,7 @@ 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
@@ -1956,7 +1956,7 @@ MmioBitFieldOr32 (
   If EndBit is greater than 31, then ASSERT().\r
   If EndBit is less than StartBit, 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
@@ -1991,7 +1991,7 @@ 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
@@ -1999,7 +1999,7 @@ MmioBitFieldAnd32 (
   If EndBit is greater than 31, then ASSERT().\r
   If EndBit is less than StartBit, 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
@@ -2128,7 +2128,7 @@ MmioAndThenOr64 (
   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
@@ -2161,7 +2161,7 @@ MmioBitFieldRead64 (
   If EndBit is greater than 63, then ASSERT().\r
   If EndBit is less than StartBit, 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
@@ -2194,7 +2194,7 @@ 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
@@ -2203,7 +2203,7 @@ MmioBitFieldWrite64 (
   If EndBit is greater than 63, then ASSERT().\r
   If EndBit is less than StartBit, 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
@@ -2236,7 +2236,7 @@ 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
@@ -2245,7 +2245,7 @@ MmioBitFieldOr64 (
   If EndBit is greater than 63, then ASSERT().\r
   If EndBit is less than StartBit, 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
@@ -2280,7 +2280,7 @@ 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
@@ -2288,7 +2288,7 @@ MmioBitFieldAnd64 (
   If EndBit is greater than 63, then ASSERT().\r
   If EndBit is less than StartBit, 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