MdePkg: Use builtin offsetof function for GCC 4.0 and newer

GCC 4.0 and newer have a builtin function for implementing
'offsetof' therefore we make use of it for our OFFSET_OF
macro.

References:
http://gcc.gnu.org/onlinedocs/gcc-4.0.0/gcc/Offsetof.html
http://gcc.gnu.org/onlinedocs/gcc-4.5.1/gcc/Offsetof.html

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@10931 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/MdePkg/Include/Base.h b/MdePkg/Include/Base.h
index 6f411b08bc1528ca2d2e575eefc656a59c068ccc..e93f68115513b3907f8447357780808a66a27b91 100644 (file)
--- a/MdePkg/Include/Base.h
+++ b/MdePkg/Include/Base.h
@@ -1,8 +1,8 @@
 /** @file\r
   Root include file for Mde Package Base type modules\r
 \r
 /** @file\r
   Root include file for Mde Package Base type modules\r
 \r

-  This is the include file for any module of type base. Base modules only use \r
-  types defined via this include file and can be ported easily to any \r
+  This is the include file for any module of type base. Base modules only use\r
+  types defined via this include file and can be ported easily to any\r

   environment. There are a set of base libraries in the Mde Package that can\r
   be used to implement base modules.\r
 \r
   environment. There are a set of base libraries in the Mde Package that can\r
   be used to implement base modules.\r
 \r


@@ -30,7 +30,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 /**\r
   Verifies the storage size of a given data type.\r
 \r
 /**\r
   Verifies the storage size of a given data type.\r

-  \r
+\r

   This macro generates a divide by zero error or a zero size array declaration in\r
   the preprocessor if the size is incorrect.  These are declared as "extern" so\r
   the space for these arrays will not be in the modules.\r
   This macro generates a divide by zero error or a zero size array declaration in\r
   the preprocessor if the size is incorrect.  These are declared as "extern" so\r
   the space for these arrays will not be in the modules.\r


@@ -42,8 +42,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #define VERIFY_SIZE_OF(TYPE, Size) extern UINT8 _VerifySizeof##TYPE[(sizeof(TYPE) == (Size)) / (sizeof(TYPE) == (Size))]\r
 \r
 //\r
 #define VERIFY_SIZE_OF(TYPE, Size) extern UINT8 _VerifySizeof##TYPE[(sizeof(TYPE) == (Size)) / (sizeof(TYPE) == (Size))]\r
 \r
 //\r

-// Verify that ProcessorBind.h produced UEFI Data Types that are compliant with \r
-// Section 2.3.1 of the UEFI 2.3 Specification.  \r
+// Verify that ProcessorBind.h produced UEFI Data Types that are compliant with\r
+// Section 2.3.1 of the UEFI 2.3 Specification.\r

 //\r
 VERIFY_SIZE_OF (BOOLEAN, 1);\r
 VERIFY_SIZE_OF (INT8, 1);\r
 //\r
 VERIFY_SIZE_OF (BOOLEAN, 1);\r
 VERIFY_SIZE_OF (INT8, 1);\r


@@ -59,19 +59,19 @@ VERIFY_SIZE_OF (CHAR16, 2);
 \r
 //\r
 // The Microsoft* C compiler can removed references to unreferenced data items\r
 \r
 //\r
 // The Microsoft* C compiler can removed references to unreferenced data items\r

-//  if the /OPT:REF linker option is used. We defined a macro as this is a \r
+//  if the /OPT:REF linker option is used. We defined a macro as this is a\r

 //  a non standard extension\r
 //\r
 #if defined(_MSC_EXTENSIONS) && !defined (MDE_CPU_EBC)\r
   ///\r
 //  a non standard extension\r
 //\r
 #if defined(_MSC_EXTENSIONS) && !defined (MDE_CPU_EBC)\r
   ///\r

-  /// Remove global variable from the linked image if there are no references to \r
+  /// Remove global variable from the linked image if there are no references to\r

   /// it after all compiler and linker optimizations have been performed.\r
   ///\r
   ///\r
   #define GLOBAL_REMOVE_IF_UNREFERENCED __declspec(selectany)\r
 #else\r
   ///\r
   /// it after all compiler and linker optimizations have been performed.\r
   ///\r
   ///\r
   #define GLOBAL_REMOVE_IF_UNREFERENCED __declspec(selectany)\r
 #else\r
   ///\r

-  /// Remove the global variable from the linked image if there are no references \r
+  /// Remove the global variable from the linked image if there are no references\r

   ///  to it after all compiler and linker optimizations have been performed.\r
   ///\r
   ///\r
   ///  to it after all compiler and linker optimizations have been performed.\r
   ///\r
   ///\r


@@ -97,7 +97,7 @@ VERIFY_SIZE_OF (CHAR16, 2);
 \r
 #if __APPLE__\r
   //\r
 \r
 #if __APPLE__\r
   //\r

-  // Apple extension that is used by the linker to optimize code size \r
+  // Apple extension that is used by the linker to optimize code size\r

   // with assembly functions. Put at the end of your .S files\r
   //\r
   #define ASM_FUNCTION_REMOVE_IF_UNREFERENCED  .subsections_via_symbols\r
   // with assembly functions. Put at the end of your .S files\r
   //\r
   #define ASM_FUNCTION_REMOVE_IF_UNREFERENCED  .subsections_via_symbols\r


@@ -107,7 +107,7 @@ VERIFY_SIZE_OF (CHAR16, 2);
 \r
 #ifdef __CC_ARM\r
   //\r
 \r
 #ifdef __CC_ARM\r
   //\r

-  // Older RVCT ARM compilers don't fully support #pragma pack and require __packed \r
+  // Older RVCT ARM compilers don't fully support #pragma pack and require __packed\r

   // as a prefix for the structure.\r
   //\r
   #define PACKED  __packed\r
   // as a prefix for the structure.\r
   //\r
   #define PACKED  __packed\r


@@ -116,7 +116,7 @@ VERIFY_SIZE_OF (CHAR16, 2);
 #endif\r
 \r
 ///\r
 #endif\r
 \r
 ///\r

-/// 128 bit buffer containing a unique identifier value.  \r
+/// 128 bit buffer containing a unique identifier value.\r

 /// Unless otherwise specified, aligned on a 64 bit boundary.\r
 ///\r
 typedef struct {\r
 /// Unless otherwise specified, aligned on a 64 bit boundary.\r
 ///\r
 typedef struct {\r


@@ -185,7 +185,7 @@ struct _LIST_ENTRY {
 #define OPTIONAL\r
 \r
 //\r
 #define OPTIONAL\r
 \r
 //\r

-//  UEFI specification claims 1 and 0. We are concerned about the \r
+//  UEFI specification claims 1 and 0. We are concerned about the\r

 //  complier portability so we did it this way.\r
 //\r
 \r
 //  complier portability so we did it this way.\r
 //\r
 \r


@@ -326,7 +326,7 @@ struct _LIST_ENTRY {
 #define  SIZE_2EB    0x2000000000000000ULL\r
 #define  SIZE_4EB    0x4000000000000000ULL\r
 #define  SIZE_8EB    0x8000000000000000ULL\r
 #define  SIZE_2EB    0x2000000000000000ULL\r
 #define  SIZE_4EB    0x4000000000000000ULL\r
 #define  SIZE_8EB    0x8000000000000000ULL\r

- \r
+\r

 #define  BASE_1KB    0x00000400\r
 #define  BASE_2KB    0x00000800\r
 #define  BASE_4KB    0x00001000\r
 #define  BASE_1KB    0x00000400\r
 #define  BASE_2KB    0x00000800\r
 #define  BASE_4KB    0x00001000\r


@@ -384,7 +384,7 @@ struct _LIST_ENTRY {
 \r
 //\r
 //  Support for variable length argument lists using the ANSI standard.\r
 \r
 //\r
 //  Support for variable length argument lists using the ANSI standard.\r

-//  \r
+//\r

 //  Since we are using the ANSI standard we used the standard naming and\r
 //  did not follow the coding convention\r
 //\r
 //  Since we are using the ANSI standard we used the standard naming and\r
 //  did not follow the coding convention\r
 //\r


@@ -437,8 +437,8 @@ struct _LIST_ENTRY {
 //\r
 \r
 ///\r
 //\r
 \r
 ///\r

-/// Variable used to traverse the list of arguments. This type can vary by \r
-/// implementation and could be an array or structure. \r
+/// Variable used to traverse the list of arguments. This type can vary by\r
+/// implementation and could be an array or structure.\r

 ///\r
 #ifdef __APCS_ADSABI\r
   typedef int         *va_list[1];\r
 ///\r
 #ifdef __APCS_ADSABI\r
   typedef int         *va_list[1];\r


@@ -460,8 +460,8 @@ struct _LIST_ENTRY {
 //\r
 \r
 ///\r
 //\r
 \r
 ///\r

-/// Variable used to traverse the list of arguments. This type can vary by \r
-/// implementation and could be an array or structure. \r
+/// Variable used to traverse the list of arguments. This type can vary by\r
+/// implementation and could be an array or structure.\r

 ///\r
 typedef __builtin_va_list VA_LIST;\r
 \r
 ///\r
 typedef __builtin_va_list VA_LIST;\r
 \r


@@ -473,42 +473,42 @@ typedef __builtin_va_list VA_LIST;
 \r
 #else\r
 ///\r
 \r
 #else\r
 ///\r

-/// Variable used to traverse the list of arguments. This type can vary by \r
-/// implementation and could be an array or structure. \r
+/// Variable used to traverse the list of arguments. This type can vary by\r
+/// implementation and could be an array or structure.\r

 ///\r
 typedef CHAR8 *VA_LIST;\r
 \r
 /**\r
 ///\r
 typedef CHAR8 *VA_LIST;\r
 \r
 /**\r

-  Retrieves a pointer to the beginning of a variable argument list, based on \r
-  the name of the parameter that immediately precedes the variable argument list. \r
+  Retrieves a pointer to the beginning of a variable argument list, based on\r
+  the name of the parameter that immediately precedes the variable argument list.\r

 \r
 \r

-  This function initializes Marker to point to the beginning of the variable  \r
-  argument list that immediately follows Parameter.  The method for computing the \r
-  pointer to the next argument in the argument list is CPU-specific following the \r
+  This function initializes Marker to point to the beginning of the variable\r
+  argument list that immediately follows Parameter.  The method for computing the\r
+  pointer to the next argument in the argument list is CPU-specific following the\r

   EFIAPI ABI.\r
 \r
   @param   Marker       The VA_LIST used to traverse the list of arguments.\r
   EFIAPI ABI.\r
 \r
   @param   Marker       The VA_LIST used to traverse the list of arguments.\r

-  @param   Parameter    The name of the parameter that immediately precedes \r
+  @param   Parameter    The name of the parameter that immediately precedes\r

                         the variable argument list.\r
                         the variable argument list.\r

-  \r
+\r

   @return  A pointer to the beginning of a variable argument list.\r
 \r
 **/\r
 #define VA_START(Marker, Parameter) (Marker = (VA_LIST) ((UINTN) & (Parameter) + _INT_SIZE_OF (Parameter)))\r
 \r
 /**\r
   @return  A pointer to the beginning of a variable argument list.\r
 \r
 **/\r
 #define VA_START(Marker, Parameter) (Marker = (VA_LIST) ((UINTN) & (Parameter) + _INT_SIZE_OF (Parameter)))\r
 \r
 /**\r

-  Returns an argument of a specified type from a variable argument list and updates \r
-  the pointer to the variable argument list to point to the next argument. \r
+  Returns an argument of a specified type from a variable argument list and updates\r
+  the pointer to the variable argument list to point to the next argument.\r

 \r
 \r

-  This function returns an argument of the type specified by TYPE from the beginning \r
-  of the variable argument list specified by Marker.  Marker is then updated to point \r
-  to the next argument in the variable argument list.  The method for computing the \r
+  This function returns an argument of the type specified by TYPE from the beginning\r
+  of the variable argument list specified by Marker.  Marker is then updated to point\r
+  to the next argument in the variable argument list.  The method for computing the\r

   pointer to the next argument in the argument list is CPU-specific following the EFIAPI ABI.\r
 \r
   @param   Marker   VA_LIST used to traverse the list of arguments.\r
   pointer to the next argument in the argument list is CPU-specific following the EFIAPI ABI.\r
 \r
   @param   Marker   VA_LIST used to traverse the list of arguments.\r

-  @param   TYPE     The type of argument to retrieve from the beginning \r
+  @param   TYPE     The type of argument to retrieve from the beginning\r

                     of the variable argument list.\r
                     of the variable argument list.\r

-  \r
+\r

   @return  An argument of the type specified by TYPE.\r
 \r
 **/\r
   @return  An argument of the type specified by TYPE.\r
 \r
 **/\r


@@ -517,12 +517,12 @@ typedef CHAR8 *VA_LIST;
 /**\r
   Terminates the use of a variable argument list.\r
 \r
 /**\r
   Terminates the use of a variable argument list.\r
 \r

-  This function initializes Marker so it can no longer be used with VA_ARG().  \r
-  After this macro is used, the only way to access the variable argument list is \r
+  This function initializes Marker so it can no longer be used with VA_ARG().\r
+  After this macro is used, the only way to access the variable argument list is\r

   by using VA_START() again.\r
 \r
   @param   Marker   VA_LIST used to traverse the list of arguments.\r
   by using VA_START() again.\r
 \r
   @param   Marker   VA_LIST used to traverse the list of arguments.\r

-  \r
+\r

 **/\r
 #define VA_END(Marker)      (Marker = (VA_LIST) 0)\r
 \r
 **/\r
 #define VA_END(Marker)      (Marker = (VA_LIST) 0)\r
 \r


@@ -543,130 +543,138 @@ typedef UINTN  *BASE_LIST;
 #define _BASE_INT_SIZE_OF(TYPE) ((sizeof (TYPE) + sizeof (UINTN) - 1) / sizeof (UINTN))\r
 \r
 /**\r
 #define _BASE_INT_SIZE_OF(TYPE) ((sizeof (TYPE) + sizeof (UINTN) - 1) / sizeof (UINTN))\r
 \r
 /**\r

-  Returns an argument of a specified type from a variable argument list and updates \r
-  the pointer to the variable argument list to point to the next argument. \r
+  Returns an argument of a specified type from a variable argument list and updates\r
+  the pointer to the variable argument list to point to the next argument.\r

 \r
 \r

-  This function returns an argument of the type specified by TYPE from the beginning \r
-  of the variable argument list specified by Marker.  Marker is then updated to point \r
-  to the next argument in the variable argument list.  The method for computing the \r
+  This function returns an argument of the type specified by TYPE from the beginning\r
+  of the variable argument list specified by Marker.  Marker is then updated to point\r
+  to the next argument in the variable argument list.  The method for computing the\r

   pointer to the next argument in the argument list is CPU specific following the EFIAPI ABI.\r
 \r
   @param   Marker   The pointer to the beginning of a variable argument list.\r
   pointer to the next argument in the argument list is CPU specific following the EFIAPI ABI.\r
 \r
   @param   Marker   The pointer to the beginning of a variable argument list.\r

-  @param   TYPE     The type of argument to retrieve from the beginning \r
+  @param   TYPE     The type of argument to retrieve from the beginning\r

                     of the variable argument list.\r
                     of the variable argument list.\r

-  \r
+\r

   @return  An argument of the type specified by TYPE.\r
 \r
 **/\r
 #define BASE_ARG(Marker, TYPE)   (*(TYPE *) ((Marker += _BASE_INT_SIZE_OF (TYPE)) - _BASE_INT_SIZE_OF (TYPE)))\r
 \r
 /**\r
   @return  An argument of the type specified by TYPE.\r
 \r
 **/\r
 #define BASE_ARG(Marker, TYPE)   (*(TYPE *) ((Marker += _BASE_INT_SIZE_OF (TYPE)) - _BASE_INT_SIZE_OF (TYPE)))\r
 \r
 /**\r

-  The macro that returns the byte offset of a field in a data structure. \r
+  The macro that returns the byte offset of a field in a data structure.\r

 \r
 \r

-  This function returns the offset, in bytes, of field specified by Field from the \r
-  beginning of the  data structure specified by TYPE. If TYPE does not contain Field, \r
-  the module will not compile.  \r
+  This function returns the offset, in bytes, of field specified by Field from the\r
+  beginning of the  data structure specified by TYPE. If TYPE does not contain Field,\r
+  the module will not compile.\r

 \r
 \r

-  @param   TYPE     The name of the data structure that contains the field specified by Field. \r
+  @param   TYPE     The name of the data structure that contains the field specified by Field.\r

   @param   Field    The name of the field in the data structure.\r
   @param   Field    The name of the field in the data structure.\r

-  \r
+\r

   @return  Offset, in bytes, of field.\r
   @return  Offset, in bytes, of field.\r

-  \r
+\r

 **/\r
 **/\r

+#ifdef __GNUC__\r
+#if __GNUC__ >= 4\r
+#define OFFSET_OF(TYPE, Field) ((UINTN) __builtin_offsetof(TYPE, Field))\r
+#endif\r
+#endif\r
+\r
+#ifndef OFFSET_OF\r

 #define OFFSET_OF(TYPE, Field) ((UINTN) &(((TYPE *)0)->Field))\r
 #define OFFSET_OF(TYPE, Field) ((UINTN) &(((TYPE *)0)->Field))\r

+#endif\r

 \r
 /**\r
 \r
 /**\r

-  Macro that returns a pointer to the data structure that contains a specified field of \r
-  that data structure.  This is a lightweight method to hide information by placing a \r
-  public data structure inside a larger private data structure and using a pointer to \r
+  Macro that returns a pointer to the data structure that contains a specified field of\r
+  that data structure.  This is a lightweight method to hide information by placing a\r
+  public data structure inside a larger private data structure and using a pointer to\r

   the public data structure to retrieve a pointer to the private data structure.\r
 \r
   the public data structure to retrieve a pointer to the private data structure.\r
 \r

-  This function computes the offset, in bytes, of field specified by Field from the beginning \r
-  of the  data structure specified by TYPE.  This offset is subtracted from Record, and is \r
-  used to return a pointer to a data structure of the type specified by TYPE. If the data type \r
-  specified by TYPE does not contain the field specified by Field, then the module will not compile. \r
-   \r
-  @param   Record   Pointer to the field specified by Field within a data structure of type TYPE. \r
-  @param   TYPE     The name of the data structure type to return.  This data structure must \r
-                    contain the field specified by Field. \r
+  This function computes the offset, in bytes, of field specified by Field from the beginning\r
+  of the  data structure specified by TYPE.  This offset is subtracted from Record, and is\r
+  used to return a pointer to a data structure of the type specified by TYPE. If the data type\r
+  specified by TYPE does not contain the field specified by Field, then the module will not compile.\r
+\r
+  @param   Record   Pointer to the field specified by Field within a data structure of type TYPE.\r
+  @param   TYPE     The name of the data structure type to return.  This data structure must\r
+                    contain the field specified by Field.\r

   @param   Field    The name of the field in the data structure specified by TYPE to which Record points.\r
   @param   Field    The name of the field in the data structure specified by TYPE to which Record points.\r

-  \r
+\r

   @return  A pointer to the structure from one of it's elements.\r
   @return  A pointer to the structure from one of it's elements.\r

-  \r
+\r

 **/\r
 #define BASE_CR(Record, TYPE, Field)  ((TYPE *) ((CHAR8 *) (Record) - (CHAR8 *) &(((TYPE *) 0)->Field)))\r
 \r
 /**\r
 **/\r
 #define BASE_CR(Record, TYPE, Field)  ((TYPE *) ((CHAR8 *) (Record) - (CHAR8 *) &(((TYPE *) 0)->Field)))\r
 \r
 /**\r

-  Rounds a value up to the next boundary using a specified alignment.  \r
+  Rounds a value up to the next boundary using a specified alignment.\r

 \r
 \r

-  This function rounds Value up to the next boundary using the specified Alignment.  \r
-  This aligned value is returned.  \r
+  This function rounds Value up to the next boundary using the specified Alignment.\r
+  This aligned value is returned.\r

 \r
   @param   Value      The value to round up.\r
   @param   Alignment  The alignment boundary used to return the aligned value.\r
 \r
   @param   Value      The value to round up.\r
   @param   Alignment  The alignment boundary used to return the aligned value.\r

-  \r
+\r

   @return  A value up to the next boundary.\r
   @return  A value up to the next boundary.\r

-  \r
+\r

 **/\r
 #define ALIGN_VALUE(Value, Alignment) ((Value) + (((Alignment) - (Value)) & ((Alignment) - 1)))\r
 \r
 /**\r
 **/\r
 #define ALIGN_VALUE(Value, Alignment) ((Value) + (((Alignment) - (Value)) & ((Alignment) - 1)))\r
 \r
 /**\r

-  Adjust a pointer by adding the minimum offset required for it to be aligned on \r
-  a specified alignment boundary.  \r
+  Adjust a pointer by adding the minimum offset required for it to be aligned on\r
+  a specified alignment boundary.\r

 \r
 \r

-  This function rounds the pointer specified by Pointer to the next alignment boundary \r
-  specified by Alignment. The pointer to the aligned address is returned.  \r
+  This function rounds the pointer specified by Pointer to the next alignment boundary\r
+  specified by Alignment. The pointer to the aligned address is returned.\r

 \r
   @param   Pointer    The pointer to round up.\r
   @param   Alignment  The alignment boundary to use to return an aligned pointer.\r
 \r
   @param   Pointer    The pointer to round up.\r
   @param   Alignment  The alignment boundary to use to return an aligned pointer.\r

-  \r
+\r

   @return  Pointer to the aligned address.\r
   @return  Pointer to the aligned address.\r

-  \r
+\r

 **/\r
 #define ALIGN_POINTER(Pointer, Alignment) ((VOID *) (ALIGN_VALUE ((UINTN)(Pointer), (Alignment))))\r
 \r
 /**\r
 **/\r
 #define ALIGN_POINTER(Pointer, Alignment) ((VOID *) (ALIGN_VALUE ((UINTN)(Pointer), (Alignment))))\r
 \r
 /**\r

-  Rounds a value up to the next natural boundary for the current CPU.  \r
-  This is 4-bytes for 32-bit CPUs and 8-bytes for 64-bit CPUs.   \r
+  Rounds a value up to the next natural boundary for the current CPU.\r
+  This is 4-bytes for 32-bit CPUs and 8-bytes for 64-bit CPUs.\r

 \r
 \r

-  This function rounds the value specified by Value up to the next natural boundary for the \r
-  current CPU. This rounded value is returned.  \r
+  This function rounds the value specified by Value up to the next natural boundary for the\r
+  current CPU. This rounded value is returned.\r

 \r
   @param   Value      The value to round up.\r
 \r
   @return  Rounded value specified by Value.\r
 \r
   @param   Value      The value to round up.\r
 \r
   @return  Rounded value specified by Value.\r

-  \r
+\r

 **/\r
 #define ALIGN_VARIABLE(Value)  ALIGN_VALUE ((Value), sizeof (UINTN))\r
 **/\r
 #define ALIGN_VARIABLE(Value)  ALIGN_VALUE ((Value), sizeof (UINTN))\r

-  \r
+\r

 \r
 /**\r
 \r
 /**\r

-  Return the maximum of two operands. \r
+  Return the maximum of two operands.\r

 \r
 \r

-  This macro returns the maximum of two operand specified by a and b.  \r
+  This macro returns the maximum of two operand specified by a and b.\r

   Both a and b must be the same numerical types, signed or unsigned.\r
 \r
   @param   a        The first operand with any numerical type.\r
   Both a and b must be the same numerical types, signed or unsigned.\r
 \r
   @param   a        The first operand with any numerical type.\r

-  @param   b        The second operand. Can be any numerical type as long as is \r
+  @param   b        The second operand. Can be any numerical type as long as is\r

                     the same type as a.\r
                     the same type as a.\r

-  \r
+\r

   @return  Maximum of two operands.\r
   @return  Maximum of two operands.\r

-  \r
+\r

 **/\r
 #define MAX(a, b)                       \\r
   (((a) > (b)) ? (a) : (b))\r
 \r
 /**\r
 **/\r
 #define MAX(a, b)                       \\r
   (((a) > (b)) ? (a) : (b))\r
 \r
 /**\r

-  Return the minimum of two operands. \r
+  Return the minimum of two operands.\r

 \r
 \r

-  This macro returns the minimal of two operand specified by a and b.  \r
+  This macro returns the minimal of two operand specified by a and b.\r

   Both a and b must be the same numerical types, signed or unsigned.\r
 \r
   @param   a        The first operand with any numerical type.\r
   @param   b        The second operand. It should be the same any numerical type with a.\r
   Both a and b must be the same numerical types, signed or unsigned.\r
 \r
   @param   a        The first operand with any numerical type.\r
   @param   b        The second operand. It should be the same any numerical type with a.\r

-  \r
+\r

   @return  Minimum of two operands.\r
   @return  Minimum of two operands.\r

-  \r
+\r

 **/\r
 \r
 #define MIN(a, b)                       \\r
 **/\r
 \r
 #define MIN(a, b)                       \\r


@@ -678,9 +686,9 @@ typedef UINTN  *BASE_LIST;
 typedef UINTN RETURN_STATUS;\r
 \r
 /**\r
 typedef UINTN RETURN_STATUS;\r
 \r
 /**\r

-  Produces a RETURN_STATUS code with the highest bit set. \r
+  Produces a RETURN_STATUS code with the highest bit set.\r

 \r
 \r

-  @param  StatusCode    The status code value to convert into a warning code.  \r
+  @param  StatusCode    The status code value to convert into a warning code.\r

                         StatusCode must be in the range 0x00000000..0x7FFFFFFF.\r
 \r
   @return The value specified by StatusCode with the highest bit set.\r
                         StatusCode must be in the range 0x00000000..0x7FFFFFFF.\r
 \r
   @return The value specified by StatusCode with the highest bit set.\r


@@ -689,9 +697,9 @@ typedef UINTN RETURN_STATUS;
 #define ENCODE_ERROR(StatusCode)     ((RETURN_STATUS)(MAX_BIT | (StatusCode)))\r
 \r
 /**\r
 #define ENCODE_ERROR(StatusCode)     ((RETURN_STATUS)(MAX_BIT | (StatusCode)))\r
 \r
 /**\r

-  Produces a RETURN_STATUS code with the highest bit clear. \r
+  Produces a RETURN_STATUS code with the highest bit clear.\r

 \r
 \r

-  @param  StatusCode    The status code value to convert into a warning code.  \r
+  @param  StatusCode    The status code value to convert into a warning code.\r

                         StatusCode must be in the range 0x00000000..0x7FFFFFFF.\r
 \r
   @return The value specified by StatusCode with the highest bit clear.\r
                         StatusCode must be in the range 0x00000000..0x7FFFFFFF.\r
 \r
   @return The value specified by StatusCode with the highest bit clear.\r


@@ -700,10 +708,10 @@ typedef UINTN RETURN_STATUS;
 #define ENCODE_WARNING(StatusCode)   ((RETURN_STATUS)(StatusCode))\r
 \r
 /**\r
 #define ENCODE_WARNING(StatusCode)   ((RETURN_STATUS)(StatusCode))\r
 \r
 /**\r

-  Returns TRUE if a specified RETURN_STATUS code is an error code. \r
+  Returns TRUE if a specified RETURN_STATUS code is an error code.\r
+\r
+  This function returns TRUE if StatusCode has the high bit set.  Otherwise, FALSE is returned.\r

 \r
 \r

-  This function returns TRUE if StatusCode has the high bit set.  Otherwise, FALSE is returned.  \r
-  \r

   @param  StatusCode    The status code value to evaluate.\r
 \r
   @retval TRUE          The high bit of StatusCode is set.\r
   @param  StatusCode    The status code value to evaluate.\r
 \r
   @retval TRUE          The high bit of StatusCode is set.\r


@@ -766,7 +774,7 @@ typedef UINTN RETURN_STATUS;
 #define RETURN_OUT_OF_RESOURCES      ENCODE_ERROR (9)\r
 \r
 ///\r
 #define RETURN_OUT_OF_RESOURCES      ENCODE_ERROR (9)\r
 \r
 ///\r

-/// An inconsistency was detected on the file system causing the \r
+/// An inconsistency was detected on the file system causing the\r

 /// operation to fail.\r
 ///\r
 #define RETURN_VOLUME_CORRUPTED      ENCODE_ERROR (10)\r
 /// operation to fail.\r
 ///\r
 #define RETURN_VOLUME_CORRUPTED      ENCODE_ERROR (10)\r


@@ -777,7 +785,7 @@ typedef UINTN RETURN_STATUS;
 #define RETURN_VOLUME_FULL           ENCODE_ERROR (11)\r
 \r
 ///\r
 #define RETURN_VOLUME_FULL           ENCODE_ERROR (11)\r
 \r
 ///\r

-/// The device does not contain any medium to perform the \r
+/// The device does not contain any medium to perform the\r

 /// operation.\r
 ///\r
 #define RETURN_NO_MEDIA              ENCODE_ERROR (12)\r
 /// operation.\r
 ///\r
 #define RETURN_NO_MEDIA              ENCODE_ERROR (12)\r


@@ -893,17 +901,17 @@ typedef UINTN RETURN_STATUS;
 #define RETURN_WARN_WRITE_FAILURE    ENCODE_WARNING (3)\r
 \r
 ///\r
 #define RETURN_WARN_WRITE_FAILURE    ENCODE_WARNING (3)\r
 \r
 ///\r

-/// The resulting buffer was too small, and the data was \r
+/// The resulting buffer was too small, and the data was\r

 /// truncated to the buffer size.\r
 ///\r
 #define RETURN_WARN_BUFFER_TOO_SMALL ENCODE_WARNING (4)\r
 \r
 /**\r
   Returns a 16-bit signature built from 2 ASCII characters.\r
 /// truncated to the buffer size.\r
 ///\r
 #define RETURN_WARN_BUFFER_TOO_SMALL ENCODE_WARNING (4)\r
 \r
 /**\r
   Returns a 16-bit signature built from 2 ASCII characters.\r

-  \r
-  This macro returns a 16-bit value built from the two ASCII characters specified \r
+\r
+  This macro returns a 16-bit value built from the two ASCII characters specified\r

   by A and B.\r
   by A and B.\r

-  \r
+\r

   @param  A    The first ASCII character.\r
   @param  B    The second ASCII character.\r
 \r
   @param  A    The first ASCII character.\r
   @param  B    The second ASCII character.\r
 \r


@@ -914,10 +922,10 @@ typedef UINTN RETURN_STATUS;
 \r
 /**\r
   Returns a 32-bit signature built from 4 ASCII characters.\r
 \r
 /**\r
   Returns a 32-bit signature built from 4 ASCII characters.\r

-  \r
-  This macro returns a 32-bit value built from the four ASCII characters specified \r
+\r
+  This macro returns a 32-bit value built from the four ASCII characters specified\r

   by A, B, C, and D.\r
   by A, B, C, and D.\r

-  \r
+\r

   @param  A    The first ASCII character.\r
   @param  B    The second ASCII character.\r
   @param  C    The third ASCII character.\r
   @param  A    The first ASCII character.\r
   @param  B    The second ASCII character.\r
   @param  C    The third ASCII character.\r


@@ -931,10 +939,10 @@ typedef UINTN RETURN_STATUS;
 \r
 /**\r
   Returns a 64-bit signature built from 8 ASCII characters.\r
 \r
 /**\r
   Returns a 64-bit signature built from 8 ASCII characters.\r

-  \r
-  This macro returns a 64-bit value built from the eight ASCII characters specified \r
+\r
+  This macro returns a 64-bit value built from the eight ASCII characters specified\r

   by A, B, C, D, E, F, G,and H.\r
   by A, B, C, D, E, F, G,and H.\r

-  \r
+\r

   @param  A    The first ASCII character.\r
   @param  B    The second ASCII character.\r
   @param  C    The third ASCII character.\r
   @param  A    The first ASCII character.\r
   @param  B    The second ASCII character.\r
   @param  C    The third ASCII character.\r