Make comments match the Spec.

[mirror_edk2.git] / MdePkg / Include / Library / BaseLib.h

diff --git a/MdePkg/Include/Library/BaseLib.h b/MdePkg/Include/Library/BaseLib.h
index 4af0330f1a7841c70a73e4bced0983f80ed87bdd..c4284eac253cfab0f5c8bd928c97b9212cc6812b 100644 (file)
--- a/MdePkg/Include/Library/BaseLib.h
+++ b/MdePkg/Include/Library/BaseLib.h
@@ -2309,7 +2309,7 @@ BitFieldWrite8 (
   Reads a bit field from an 8-bit value, performs a bitwise OR, and returns the\r
   result.\r
 \r
-  Performs a bitwise inclusive OR between the bit field specified by StartBit\r
+  Performs a bitwise OR between the bit field specified by StartBit\r
   and EndBit in Operand and the value specified by OrData. All other bits in\r
   Operand are preserved. The new 8-bit value is returned.\r
 \r
@@ -2376,8 +2376,8 @@ BitFieldAnd8 (
   bitwise OR, and returns the result.\r
 \r
   Performs a bitwise AND between the bit field specified by StartBit and EndBit\r
-  in Operand and the value specified by AndData, followed by a bitwise\r
-  inclusive OR with value specified by OrData. All other bits in Operand are\r
+  in Operand and the value specified by AndData, followed by a bitwise \r
+  OR with value specified by OrData. All other bits in Operand are\r
   preserved. The new 8-bit value is returned.\r
 \r
   If 8-bit operations are not supported, then ASSERT().\r
@@ -2471,7 +2471,7 @@ BitFieldWrite16 (
   Reads a bit field from a 16-bit value, performs a bitwise OR, and returns the\r
   result.\r
 \r
-  Performs a bitwise inclusive OR between the bit field specified by StartBit\r
+  Performs a bitwise OR between the bit field specified by StartBit\r
   and EndBit in Operand and the value specified by OrData. All other bits in\r
   Operand are preserved. The new 16-bit value is returned.\r
 \r
@@ -2538,8 +2538,8 @@ BitFieldAnd16 (
   bitwise OR, and returns the result.\r
 \r
   Performs a bitwise AND between the bit field specified by StartBit and EndBit\r
-  in Operand and the value specified by AndData, followed by a bitwise\r
-  inclusive OR with value specified by OrData. All other bits in Operand are\r
+  in Operand and the value specified by AndData, followed by a bitwise \r
+  OR with value specified by OrData. All other bits in Operand are\r
   preserved. The new 16-bit value is returned.\r
 \r
   If 16-bit operations are not supported, then ASSERT().\r
@@ -2633,7 +2633,7 @@ BitFieldWrite32 (
   Reads a bit field from a 32-bit value, performs a bitwise OR, and returns the\r
   result.\r
 \r
-  Performs a bitwise inclusive OR between the bit field specified by StartBit\r
+  Performs a bitwise OR between the bit field specified by StartBit\r
   and EndBit in Operand and the value specified by OrData. All other bits in\r
   Operand are preserved. The new 32-bit value is returned.\r
 \r
@@ -2700,8 +2700,8 @@ BitFieldAnd32 (
   bitwise OR, and returns the result.\r
 \r
   Performs a bitwise AND between the bit field specified by StartBit and EndBit\r
-  in Operand and the value specified by AndData, followed by a bitwise\r
-  inclusive OR with value specified by OrData. All other bits in Operand are\r
+  in Operand and the value specified by AndData, followed by a bitwise \r
+  OR with value specified by OrData. All other bits in Operand are\r
   preserved. The new 32-bit value is returned.\r
 \r
   If 32-bit operations are not supported, then ASSERT().\r
@@ -2795,7 +2795,7 @@ BitFieldWrite64 (
   Reads a bit field from a 64-bit value, performs a bitwise OR, and returns the\r
   result.\r
 \r
-  Performs a bitwise inclusive OR between the bit field specified by StartBit\r
+  Performs a bitwise OR between the bit field specified by StartBit\r
   and EndBit in Operand and the value specified by OrData. All other bits in\r
   Operand are preserved. The new 64-bit value is returned.\r
 \r
@@ -2862,8 +2862,8 @@ BitFieldAnd64 (
   bitwise OR, and returns the result.\r
 \r
   Performs a bitwise AND between the bit field specified by StartBit and EndBit\r
-  in Operand and the value specified by AndData, followed by a bitwise\r
-  inclusive OR with value specified by OrData. All other bits in Operand are\r
+  in Operand and the value specified by AndData, followed by a bitwise \r
+  OR with value specified by OrData. All other bits in Operand are\r
   preserved. The new 64-bit value is returned.\r
 \r
   If 64-bit operations are not supported, then ASSERT().\r
@@ -5284,10 +5284,10 @@ AsmWriteMsr32 (
 \r
 \r
 /**\r
-  Reads a 64-bit MSR, performs a bitwise inclusive OR on the lower 32-bits, and\r
+  Reads a 64-bit MSR, performs a bitwise OR on the lower 32-bits, and\r
   writes the result back to the 64-bit MSR.\r
 \r
-  Reads the 64-bit MSR specified by Index, performs a bitwise inclusive OR\r
+  Reads the 64-bit MSR specified by Index, performs a bitwise OR\r
   between the lower 32-bits of the read result and the value specified by\r
   OrData, and writes the result to the 64-bit MSR specified by Index. The lower\r
   32-bits of the value written to the MSR is returned. No parameter checking is\r
@@ -5338,12 +5338,12 @@ AsmMsrAnd32 (
 \r
 \r
 /**\r
-  Reads a 64-bit MSR, performs a bitwise AND followed by a bitwise inclusive OR\r
+  Reads a 64-bit MSR, performs a bitwise AND followed by a bitwise OR\r
   on the lower 32-bits, and writes the result back to the 64-bit MSR.\r
 \r
   Reads the 64-bit MSR specified by Index, performs a bitwise AND between the\r
   lower 32-bits of the read result and the value specified by AndData\r
-  preserving the upper 32-bits, performs a bitwise inclusive OR between the\r
+  preserving the upper 32-bits, performs a bitwise OR between the\r
   result of the AND operation and the value specified by OrData, and writes the\r
   result to the 64-bit MSR specified by Address. The lower 32-bits of the value\r
   written to the MSR is returned. No parameter checking is performed on Index,\r
@@ -5405,10 +5405,9 @@ AsmMsrBitFieldRead32 (
   Writes Value to a bit field in the lower 32-bits of a  64-bit MSR. The bit\r
   field is specified by the StartBit and the EndBit. All other bits in the\r
   destination MSR are preserved. The lower 32-bits of the MSR written is\r
-  returned. Extra left bits in Value are stripped. The caller must either\r
-  guarantee that Index and the data written is valid, or the caller must set up\r
-  exception handlers to catch the exceptions. This function is only available\r
-  on IA-32 and x64.\r
+  returned. The caller must either guarantee that Index and the data written \r
+  is valid, or the caller must set up exception handlers to catch the exceptions. \r
+  This function is only available on IA-32 and x64.\r
 \r
   If StartBit is greater than 31, then ASSERT().\r
   If EndBit is greater than 31, then ASSERT().\r
@@ -5438,7 +5437,7 @@ AsmMsrBitFieldWrite32 (
   Reads a bit field in a 64-bit MSR, performs a bitwise OR, and writes the\r
   result back to the bit field in the 64-bit MSR.\r
 \r
-  Reads the 64-bit MSR specified by Index, performs a bitwise inclusive OR\r
+  Reads the 64-bit MSR specified by Index, performs a bitwise OR\r
   between the read result and the value specified by OrData, and writes the\r
   result to the 64-bit MSR specified by Index. The lower 32-bits of the value\r
   written to the MSR are returned. Extra left bits in OrData are stripped. The\r
@@ -5508,11 +5507,11 @@ AsmMsrBitFieldAnd32 (
 \r
 /**\r
   Reads a bit field in a 64-bit MSR, performs a bitwise AND followed by a\r
-  bitwise inclusive OR, and writes the result back to the bit field in the\r
+  bitwise OR, and writes the result back to the bit field in the\r
   64-bit MSR.\r
 \r
   Reads the 64-bit MSR specified by Index, performs a bitwise AND followed by a\r
-  bitwise inclusive OR between the read result and the value specified by\r
+  bitwise OR between the read result and the value specified by\r
   AndData, and writes the result to the 64-bit MSR specified by Index. The\r
   lower 32-bits of the value written to the MSR are returned. Extra left bits\r
   in both AndData and OrData are stripped. The caller must either guarantee\r
@@ -5593,10 +5592,10 @@ AsmWriteMsr64 (
 \r
 \r
 /**\r
-  Reads a 64-bit MSR, performs a bitwise inclusive OR, and writes the result\r
+  Reads a 64-bit MSR, performs a bitwise OR, and writes the result\r
   back to the 64-bit MSR.\r
 \r
-  Reads the 64-bit MSR specified by Index, performs a bitwise inclusive OR\r
+  Reads the 64-bit MSR specified by Index, performs a bitwise OR\r
   between the read result and the value specified by OrData, and writes the\r
   result to the 64-bit MSR specified by Index. The value written to the MSR is\r
   returned. No parameter checking is performed on Index or OrData, and some of\r
@@ -5645,11 +5644,11 @@ AsmMsrAnd64 (
 \r
 \r
 /**\r
-  Reads a 64-bit MSR, performs a bitwise AND followed by a bitwise inclusive\r
+  Reads a 64-bit MSR, performs a bitwise AND followed by a bitwise \r
   OR, and writes the result back to the 64-bit MSR.\r
 \r
   Reads the 64-bit MSR specified by Index, performs a bitwise AND between read\r
-  result and the value specified by AndData, performs a bitwise inclusive OR\r
+  result and the value specified by AndData, performs a bitwise OR\r
   between the result of the AND operation and the value specified by OrData,\r
   and writes the result to the 64-bit MSR specified by Index. The value written\r
   to the MSR is returned. No parameter checking is performed on Index, AndData,\r
@@ -5710,10 +5709,9 @@ AsmMsrBitFieldRead64 (
 \r
   Writes Value to a bit field in a 64-bit MSR. The bit field is specified by\r
   the StartBit and the EndBit. All other bits in the destination MSR are\r
-  preserved. The MSR written is returned. Extra left bits in Value are\r
-  stripped. The caller must either guarantee that Index and the data written is\r
-  valid, or the caller must set up exception handlers to catch the exceptions.\r
-  This function is only available on IA-32 and x64.\r
+  preserved. The MSR written is returned. The caller must either guarantee \r
+  that Index and the data written is valid, or the caller must set up exception \r
+  handlers to catch the exceptions. This function is only available on IA-32 and x64.\r
 \r
   If StartBit is greater than 63, then ASSERT().\r
   If EndBit is greater than 63, then ASSERT().\r
@@ -5740,10 +5738,10 @@ AsmMsrBitFieldWrite64 (
 \r
 \r
 /**\r
-  Reads a bit field in a 64-bit MSR, performs a bitwise inclusive OR, and\r
+  Reads a bit field in a 64-bit MSR, performs a bitwise OR, and\r
   writes the result back to the bit field in the 64-bit MSR.\r
 \r
-  Reads the 64-bit MSR specified by Index, performs a bitwise inclusive OR\r
+  Reads the 64-bit MSR specified by Index, performs a bitwise OR\r
   between the read result and the value specified by OrData, and writes the\r
   result to the 64-bit MSR specified by Index. The value written to the MSR is\r
   returned. Extra left bits in OrData are stripped. The caller must either\r
@@ -5813,11 +5811,11 @@ AsmMsrBitFieldAnd64 (
 \r
 /**\r
   Reads a bit field in a 64-bit MSR, performs a bitwise AND followed by a\r
-  bitwise inclusive OR, and writes the result back to the bit field in the\r
+  bitwise OR, and writes the result back to the bit field in the\r
   64-bit MSR.\r
 \r
   Reads the 64-bit MSR specified by Index, performs a bitwise AND followed by\r
-  a bitwise inclusive OR between the read result and the value specified by\r
+  a bitwise OR between the read result and the value specified by\r
   AndData, and writes the result to the 64-bit MSR specified by Index. The\r
   value written to the MSR is returned. Extra left bits in both AndData and\r
   OrData are stripped. The caller must either guarantee that Index and the data\r