Add more detailed comments for many of the Base Types

[mirror_edk2.git] / MdePkg / Include / Ia32 / ProcessorBind.h

diff --git a/MdePkg/Include/Ia32/ProcessorBind.h b/MdePkg/Include/Ia32/ProcessorBind.h
index 3f3fae73cf0e7c662494a1034f524bd7ca9a664f..9d91a16cd103897bb740363308fc285506ec1de0 100644 (file)
--- a/MdePkg/Include/Ia32/ProcessorBind.h
+++ b/MdePkg/Include/Ia32/ProcessorBind.h
@@ -98,18 +98,54 @@
   #if _MSC_EXTENSIONS \r
 \r
     //\r
-    // use Microsoft* C complier dependent interger width types \r
+    // use Microsoft C complier dependent integer width types \r
     //\r
+\r
+    ///\r
+    /// 8-byte unsigned value\r
+    ///\r
     typedef unsigned __int64    UINT64;\r
+    ///\r
+    /// 8-byte signed value\r
+    ///\r
     typedef __int64             INT64;\r
+    ///\r
+    /// 4-byte unsigned value\r
+    ///\r
     typedef unsigned __int32    UINT32;\r
+    ///\r
+    /// 4-byte signed value\r
+    ///\r
     typedef __int32             INT32;\r
+    ///\r
+    /// 2-byte unsigned value\r
+    ///\r
     typedef unsigned short      UINT16;\r
+    ///\r
+    /// 2-byte Character.  Unless otherwise specified all strings are stored in the\r
+    /// UTF-16 encoding format as defined by Unicode 2.1 and ISO/IEC 10646 standards.\r
+    ///\r
     typedef unsigned short      CHAR16;\r
+    ///\r
+    /// 2-byte signed value\r
+    ///\r
     typedef short               INT16;\r
+    ///\r
+    /// Logical Boolean.  1-byte value containing 0 for FALSE or a 1 for TRUE.  Other\r
+    /// values are undefined.\r
+    ///\r
     typedef unsigned char       BOOLEAN;\r
+    ///\r
+    /// 1-byte unsigned value\r
+    ///\r
     typedef unsigned char       UINT8;\r
+    ///\r
+    /// 1-byte Character\r
+    ///\r
     typedef char                CHAR8;\r
+    ///\r
+    /// 1-byte signed value\r
+    ///\r
     typedef char                INT8;\r
   #else\r
 \r
@@ -117,48 +153,131 @@
     // Assume standard IA-32 alignment. \r
     // Need to check portability of long long\r
     //\r
+\r
+    ///\r
+    /// 8-byte unsigned value\r
+    ///\r
     typedef unsigned long long  UINT64;\r
+    ///\r
+    /// 8-byte signed value\r
+    ///\r
     typedef long long           INT64;\r
+    ///\r
+    /// 4-byte unsigned value\r
+    ///\r
     typedef unsigned int        UINT32;\r
+    ///\r
+    /// 4-byte signed value\r
+    ///\r
     typedef int                 INT32;\r
+    ///\r
+    /// 2-byte unsigned value\r
+    ///\r
     typedef unsigned short      UINT16;\r
+    ///\r
+    /// 2-byte Character.  Unless otherwise specified all strings are stored in the\r
+    /// UTF-16 encoding format as defined by Unicode 2.1 and ISO/IEC 10646 standards.\r
+    ///\r
     typedef unsigned short      CHAR16;\r
+    ///\r
+    /// 2-byte signed value\r
+    ///\r
     typedef short               INT16;\r
+    ///\r
+    /// Logical Boolean.  1-byte value containing 0 for FALSE or a 1 for TRUE.  Other\r
+    /// values are undefined.\r
+    ///\r
     typedef unsigned char       BOOLEAN;\r
+    ///\r
+    /// 1-byte unsigned value\r
+    ///\r
     typedef unsigned char       UINT8;\r
+    ///\r
+    /// 1-byte Character\r
+    ///\r
     typedef char                CHAR8;\r
+    ///\r
+    /// 1-byte signed value\r
+    ///\r
     typedef char                INT8;\r
   #endif\r
-\r
-  #define UINT8_MAX 0xff\r
-\r
 #else\r
   //\r
   // Use ANSI C 2000 stdint.h integer width declarations\r
   //\r
-  #include "stdint.h"\r
+  #include <stdint.h>\r
+\r
+  ///\r
+  /// Logical Boolean.  1-byte value containing 0 for FALSE or a 1 for TRUE.  Other\r
+  /// values are undefined.\r
+  ///\r
   typedef uint8_t   BOOLEAN;\r
+  ///\r
+  /// 1-byte signed value\r
+  ///\r
   typedef int8_t    INT8;\r
+  ///\r
+  /// 1-byte unsigned value\r
+  ///\r
   typedef uint8_t   UINT8;\r
+  ///\r
+  /// 2-byte signed value\r
+  ///\r
   typedef int16_t   INT16;\r
+  ///\r
+  /// 2-byte unsigned value\r
+  ///\r
   typedef uint16_t  UINT16;\r
+  ///\r
+  /// 4-byte signed value\r
+  ///\r
   typedef int32_t   INT32;\r
+  ///\r
+  /// 4-byte unsigned value\r
+  ///\r
   typedef uint32_t  UINT32;\r
+  ///\r
+  /// 8-byte signed value\r
+  ///\r
   typedef int64_t   INT64;\r
+  ///\r
+  /// 8-byte unsigned value\r
+  ///\r
   typedef uint64_t  UINT64;\r
+  ///\r
+  /// 1-byte Character\r
+  ///\r
   typedef char      CHAR8;\r
+  ///\r
+  /// 2-byte Character.  Unless otherwise specified all strings are stored in the\r
+  /// UTF-16 encoding format as defined by Unicode 2.1 and ISO/IEC 10646 standards.\r
+  ///\r
   typedef uint16_t  CHAR16;\r
 \r
 #endif\r
 \r
+///\r
+/// Unsigned value of native width.  (4 bytes on supported 32-bit processor instructions,\r
+/// 8 bytes on supported 64-bit processor instructions)\r
+///\r
 typedef UINT32  UINTN;\r
+///\r
+/// Signed value of native width.  (4 bytes on supported 32-bit processor instructions,\r
+/// 8 bytes on supported 64-bit processor instructions)\r
+///\r
 typedef INT32   INTN;\r
 \r
+//\r
+// Processor specific defines\r
+//\r
 \r
 ///\r
-/// Processor specific defines\r
+/// A value of native width with the highest bit set.\r
 ///\r
 #define MAX_BIT     0x80000000\r
+///\r
+/// A value of native width with the two highest bits set.\r
+///\r
 #define MAX_2_BITS  0xC0000000\r
 \r
 ///\r
@@ -178,11 +297,14 @@ typedef INT32   INTN;
 //\r
 #if _MSC_EXTENSIONS\r
   ///\r
-  /// Microsoft* compiler requires _EFIAPI useage, __cdecl is Microsoft* specific C.\r
+  /// Microsoft* compiler specific method for EFIAPI calling convension\r
   /// \r
   #define EFIAPI __cdecl  \r
 #else\r
   #if __GNUC__\r
+    ///\r
+    /// GCC specific method for EFIAPI calling convension\r
+    /// \r
     #define EFIAPI __attribute__((cdecl))  \r
   #endif  \r
 #endif\r
@@ -193,8 +315,16 @@ typedef INT32   INTN;
 //  a non standard extension\r
 //\r
 #if _MSC_EXTENSIONS\r
+  ///\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
   #define GLOBAL_REMOVE_IF_UNREFERENCED __declspec(selectany)\r
 #else\r
+  ///\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
   #define GLOBAL_REMOVE_IF_UNREFERENCED\r
 #endif\r
 \r