Add more detailed comments for many of the Base Types

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

diff --git a/MdePkg/Include/Ebc/ProcessorBind.h b/MdePkg/Include/Ebc/ProcessorBind.h
index 966ddb67813b3dbed497932e4f51f061b23e859b..b46064b8372c167630732db8aee5988ff8d04dc1 100644 (file)
--- a/MdePkg/Include/Ebc/ProcessorBind.h
+++ b/MdePkg/Include/Ebc/ProcessorBind.h
@@ -26,33 +26,76 @@
 //\r
 // Native integer types\r
 //\r
+\r
+///\r
+/// 1-byte signed value\r
+///\r
 typedef char                  INT8;\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
+///\r
+/// 2-byte signed value\r
+///\r
 typedef short                 INT16;\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
+///\r
+/// 4-byte signed value\r
+///\r
 typedef int                   INT32;\r
+///\r
+/// 4-byte unsigned value\r
+///\r
 typedef unsigned int          UINT32;\r
-\r
+///\r
+/// 8-byte signed value\r
+///\r
 typedef __int64               INT64;\r
+///\r
+/// 8-byte unsigned value\r
+///\r
 typedef unsigned __int64      UINT64;\r
 \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
 /// "long" type scales to the processor native size with EBC compiler\r
 ///\r
 typedef long                  INTN;\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
+/// "long" type scales to the processor native size with EBC compiler\r
+///\r
 typedef unsigned long         UINTN;\r
 \r
-#define UINT8_MAX 0xff\r
-\r
 ///\r
+/// A value of native width with the highest bit set.\r
 /// Scalable macro to set the most significant bit in a natural number\r
 ///\r
 #define MAX_BIT     (1ULL << (sizeof (INTN) * 8 - 1)) \r
+///\r
+/// A value of native width with the two highest bits set.\r
+/// Scalable macro to set the most 2 significant bits in a natural number\r
+///\r
 #define MAX_2_BITS  (3ULL << (sizeof (INTN) * 8 - 2))\r
 \r
 ///\r
@@ -89,7 +132,6 @@ typedef unsigned long         UINTN;
 \r
   @return The pointer to the first instruction of a function given a function pointer.\r
 **/\r
-\r
 #define FUNCTION_ENTRY_POINT(FunctionPointer) (VOID *)(UINTN)(FunctionPointer)\r
 \r
 #endif \r