Add more detailed comments for many of the Base Types

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

diff --git a/MdePkg/Include/Ipf/ProcessorBind.h b/MdePkg/Include/Ipf/ProcessorBind.h
index ac695fe38b6e3141dacc0628f50f07d3eacfc6ac..9e87d44bf40963d281b80148336178dc0f4eadcd 100644 (file)
--- a/MdePkg/Include/Ipf/ProcessorBind.h
+++ b/MdePkg/Include/Ipf/ProcessorBind.h
@@ -53,7 +53,7 @@
 #if _MSC_EXTENSIONS\r
 //\r
 // Disable warning that make it impossible to compile at /W4\r
-// This only works for Microsoft tools. \r
+// This only works for Microsoft* tools\r
 //\r
 \r
 //\r
@@ -61,7 +61,7 @@
 //\r
 #pragma warning ( disable : 4214 )\r
 \r
-\r
+//\r
 // Disabling the unreferenced formal parameter warnings.\r
 //\r
 #pragma warning ( disable : 4100 )\r
@@ -110,91 +110,247 @@
     //\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
     #ifdef _EFI_P64\r
       //\r
       // P64 - pointers being 64-bit and longs and ints are 32-bits.\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 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 unsigned value\r
+      ///\r
       typedef unsigned short      UINT16;\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
       // Assume LP64 - longs and pointers are 64-bit. Ints are 32-bit.\r
       //\r
+\r
+      ///\r
+      /// 8-byte unsigned value\r
+      ///\r
       typedef unsigned long   UINT64;\r
+      ///\r
+      /// 8-byte signed value\r
+      ///\r
       typedef 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
   #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
+\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 UINT64  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 INT64   INTN;\r
 \r
 \r
 //\r
 // Processor specific defines\r
 //\r
+\r
+///\r
+/// A value of native width with the highest bit set.\r
+///\r
 #define MAX_BIT     0x8000000000000000ULL\r
+///\r
+/// A value of native width with the two highest bits set.\r
+///\r
 #define MAX_2_BITS  0xC000000000000000ULL\r
 \r
-//\r
-// Maximum legal Itanium-based address\r
-//\r
+///\r
+/// Maximum legal Itanium-based address\r
+///\r
 #define MAX_ADDRESS   0xFFFFFFFFFFFFFFFFULL\r
 \r
-//\r
-// Per the Itanium Software Conventions and Runtime Architecture Guide,\r
-// section 3.3.4, IPF stack must always be 16-byte aligned.\r
-//\r
+///\r
+/// Per the Itanium Software Conventions and Runtime Architecture Guide,\r
+/// section 3.3.4, IPF stack must always be 16-byte aligned.\r
+///\r
 #define CPU_STACK_ALIGNMENT   16\r
 \r
 //\r
@@ -203,9 +359,9 @@ typedef INT64   INTN;
 // EFI intrinsics are required to modify their member functions with EFIAPI.\r
 //\r
 #if _MSC_EXTENSIONS\r
-  //\r
-  // Microsoft* compiler requires _EFIAPI useage, __cdecl is Microsoft* specific C.\r
-  //\r
+  ///\r
+  /// Microsoft* compiler specific method for EFIAPI calling convension\r
+  /// \r
   #define EFIAPI __cdecl\r
 #else\r
   #define EFIAPI\r
@@ -217,8 +373,18 @@ typedef INT64   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
+  ///\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
+  ///\r
   #define GLOBAL_REMOVE_IF_UNREFERENCED\r
 #endif\r
 \r
@@ -230,6 +396,9 @@ typedef struct {
   UINT64  GP;\r
 } EFI_PLABEL;\r
 \r
+///\r
+/// PAL Call return structure.\r
+///\r
 typedef struct {\r
   UINT64                    Status;\r
   UINT64                    r9;\r