//\r
#include <ProcessorBind.h>\r
\r
-\r
-//\r
-// 128 bit buffer containing a unique identifier value. \r
-// Unless otherwise specified, aligned on a 64 bit boundary.\r
-//\r
+///\r
+/// 128 bit buffer containing a unique identifier value. \r
+/// Unless otherwise specified, aligned on a 64 bit boundary.\r
+///\r
typedef struct {\r
UINT32 Data1;\r
UINT16 Data2;\r
typedef UINT64 PHYSICAL_ADDRESS;\r
\r
///\r
-/// LIST_ENTRY definition.\r
+/// LIST_ENTRY structure definition.\r
///\r
typedef struct _LIST_ENTRY LIST_ENTRY;\r
\r
+///\r
+/// _LIST_ENTRY structure definition.\r
+///\r
struct _LIST_ENTRY {\r
LIST_ENTRY *ForwardLink;\r
LIST_ENTRY *BackLink;\r
//\r
// Modifiers to abstract standard types to aid in debug of problems\r
//\r
+\r
+///\r
+/// Datum is read-only\r
+///\r
#define CONST const\r
+\r
+///\r
+/// Datum is scoped to the current file or function\r
+///\r
#define STATIC static\r
+\r
+///\r
+/// Undclared type\r
+///\r
#define VOID void\r
\r
//\r
// Modifiers for Data Types used to self document code.\r
// This concept is borrowed for UEFI specification.\r
//\r
+\r
+///\r
+/// Datum is passed to the function\r
+///\r
#define IN\r
+\r
+///\r
+/// Datum is returned from the function\r
+///\r
#define OUT\r
+\r
+///\r
+/// Passing the datum to the function is optional, and a NULL\r
+/// be passed if the value is not supplied.\r
+///\r
#define OPTIONAL\r
\r
//\r
// UEFI specification claims 1 and 0. We are concerned about the \r
// complier portability so we did it this way.\r
//\r
+\r
+///\r
+/// Boolean true value. UEFI Specification defines this value to be 1,\r
+/// but this form is more portable.\r
+///\r
#define TRUE ((BOOLEAN)(1==1))\r
+\r
+///\r
+/// Boolean false value. UEFI Specification defines this value to be 0,\r
+/// but this form is more portable.\r
+///\r
#define FALSE ((BOOLEAN)(0==1))\r
\r
-//\r
-// NULL pointer (VOID *)\r
-//\r
+///\r
+/// NULL pointer (VOID *)\r
+///\r
#define NULL ((VOID *) 0)\r
\r
\r
\r
#define _INT_SIZE_OF(n) ((sizeof (n) + sizeof (UINTN) - 1) &~(sizeof (UINTN) - 1))\r
\r
-//\r
-// Pointer to the start of a variable argument list. Same as UINT8 *.\r
-//\r
+///\r
+/// Pointer to the start of a variable argument list. Same as CHAR8 *.\r
+///\r
typedef CHAR8 *VA_LIST;\r
\r
/**\r
#define MIN(a, b) \\r
(((a) < (b)) ? (a) : (b))\r
\r
-\r
//\r
-// EFI Error Codes common to all execution phases\r
+// Status codes common to all execution phases\r
//\r
-\r
typedef INTN RETURN_STATUS;\r
\r
-///\r
-/// Set the upper bit to indicate EFI Error.\r
-///\r
-#define ENCODE_ERROR(a) (MAX_BIT | (a))\r
+/**\r
+ Produces a RETURN_STATUS code with the highest bit set. \r
\r
-#define ENCODE_WARNING(a) (a)\r
-#define RETURN_ERROR(a) ((INTN) (a) < 0)\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
+\r
+**/\r
+#define ENCODE_ERROR(StatusCode) (MAX_BIT | (StatusCode))\r
\r
+/**\r
+ Produces a RETURN_STATUS code with the highest bit clear. \r
+\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
+\r
+**/\r
+#define ENCODE_WARNING(StatusCode) (StatusCode)\r
+\r
+/**\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
+ @param StatusCode The status code value to evaluate.\r
+\r
+ @retval TRUE The high bit of StatusCode is set.\r
+ @retval FALSE The high bit of StatusCode is clear.\r
+\r
+**/\r
+#define RETURN_ERROR(StatusCode) ((INTN) (StatusCode) < 0)\r
+\r
+///\r
+/// The operation completed successfully.\r
+///\r
#define RETURN_SUCCESS 0\r
+\r
+///\r
+/// The image failed to load.\r
+///\r
#define RETURN_LOAD_ERROR ENCODE_ERROR (1)\r
+\r
+///\r
+/// The parameter was incorrect.\r
+///\r
#define RETURN_INVALID_PARAMETER ENCODE_ERROR (2)\r
+\r
+///\r
+/// The operation is not supported.\r
+///\r
#define RETURN_UNSUPPORTED ENCODE_ERROR (3)\r
+\r
+///\r
+/// The buffer was not the proper size for the request.\r
+///\r
#define RETURN_BAD_BUFFER_SIZE ENCODE_ERROR (4)\r
+\r
+///\r
+/// The buffer was not large enough to hold the requested data.\r
+/// The required buffer size is returned in the appropriate\r
+/// parameter when this error occurs.\r
+///\r
#define RETURN_BUFFER_TOO_SMALL ENCODE_ERROR (5)\r
+\r
+///\r
+/// There is no data oending upon return.\r
+///\r
#define RETURN_NOT_READY ENCODE_ERROR (6)\r
+\r
+///\r
+/// The physical device reported an error while attempting the\r
+/// operation.\r
+///\r
#define RETURN_DEVICE_ERROR ENCODE_ERROR (7)\r
+\r
+///\r
+/// The device can not be written to.\r
+///\r
#define RETURN_WRITE_PROTECTED ENCODE_ERROR (8)\r
+\r
+///\r
+/// The resource has run out.\r
+///\r
#define RETURN_OUT_OF_RESOURCES ENCODE_ERROR (9)\r
+\r
+///\r
+/// An inconsistancy was detected on the file system causing the \r
+/// operation to fail.\r
+///\r
#define RETURN_VOLUME_CORRUPTED ENCODE_ERROR (10)\r
+\r
+///\r
+/// There is no more space on the file system.\r
+///\r
#define RETURN_VOLUME_FULL ENCODE_ERROR (11)\r
+\r
+///\r
+/// The device does not contain any medium to perform the \r
+/// operation.\r
+///\r
#define RETURN_NO_MEDIA ENCODE_ERROR (12)\r
+\r
+///\r
+/// The medium in the device has changed since the last\r
+/// access.\r
+///\r
#define RETURN_MEDIA_CHANGED ENCODE_ERROR (13)\r
+\r
+///\r
+/// The item was not found.\r
+///\r
#define RETURN_NOT_FOUND ENCODE_ERROR (14)\r
+\r
+///\r
+/// Access was denied.\r
+///\r
#define RETURN_ACCESS_DENIED ENCODE_ERROR (15)\r
+\r
+///\r
+/// The server was not found or did not respond to the request.\r
+///\r
#define RETURN_NO_RESPONSE ENCODE_ERROR (16)\r
+\r
+///\r
+/// A mapping to the device does not exist.\r
+///\r
#define RETURN_NO_MAPPING ENCODE_ERROR (17)\r
+\r
+///\r
+/// A timeout time expired.\r
+///\r
#define RETURN_TIMEOUT ENCODE_ERROR (18)\r
+\r
+///\r
+/// The protocol has not been started.\r
+///\r
#define RETURN_NOT_STARTED ENCODE_ERROR (19)\r
+\r
+///\r
+/// The protocol has already been started.\r
+///\r
#define RETURN_ALREADY_STARTED ENCODE_ERROR (20)\r
+\r
+///\r
+/// The operation was aborted.\r
+///\r
#define RETURN_ABORTED ENCODE_ERROR (21)\r
+\r
+///\r
+/// An ICMP error occurred during the nrtwork operation.\r
+///\r
#define RETURN_ICMP_ERROR ENCODE_ERROR (22)\r
+\r
+///\r
+/// A TFTP error occurred during the nrtwork operation.\r
+///\r
#define RETURN_TFTP_ERROR ENCODE_ERROR (23)\r
+\r
+///\r
+/// A protocol error occurred during the nrtwork operation.\r
+///\r
#define RETURN_PROTOCOL_ERROR ENCODE_ERROR (24)\r
+\r
+///\r
+/// A function encountered an internal version that was\r
+/// iuncomptible with a version requested by the caller.\r
+///\r
#define RETURN_INCOMPATIBLE_VERSION ENCODE_ERROR (25)\r
+\r
+///\r
+/// The function was not performed due to a security violation.\r
+///\r
#define RETURN_SECURITY_VIOLATION ENCODE_ERROR (26)\r
+\r
+///\r
+/// A CRC error was detected.\r
+///\r
#define RETURN_CRC_ERROR ENCODE_ERROR (27)\r
+\r
+///\r
+/// Beginning or end of media was reached.\r
+///\r
#define RETURN_END_OF_MEDIA ENCODE_ERROR (28)\r
+\r
+///\r
+/// The end of the file was reached.\r
+///\r
#define RETURN_END_OF_FILE ENCODE_ERROR (31)\r
+\r
+///\r
+/// The language specified was invalid.\r
+///\r
#define RETURN_INVALID_LANGUAGE ENCODE_ERROR (32)\r
\r
\r
+///\r
+/// The Unicode string contained one or more characters that\r
+/// the device could not render and were skipped.\r
+///\r
#define RETURN_WARN_UNKNOWN_GLYPH ENCODE_WARNING (1)\r
+\r
+///\r
+/// The handle was closed, but the file was not deleted.\r
+///\r
#define RETURN_WARN_DELETE_FAILURE ENCODE_WARNING (2)\r
+\r
+///\r
+/// The handle was closed, but the data to the file was not\r
+/// flushed properly.\r
+///\r
#define RETURN_WARN_WRITE_FAILURE ENCODE_WARNING (3)\r
+\r
+///\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
//\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
\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
#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
// 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
//\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
// 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
#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
//\r
#pragma warning ( disable : 4214 )\r
\r
-\r
+//\r
// Disabling the unreferenced formal parameter warnings.\r
//\r
#pragma warning ( disable : 4100 )\r
//\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
// 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
// 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
UINT64 GP;\r
} EFI_PLABEL;\r
\r
+///\r
+/// PAL Call return structure.\r
+///\r
typedef struct {\r
UINT64 Status;\r
UINT64 r9;\r
//\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 x64 address\r
-//\r
+///\r
+/// Maximum legal x64 address\r
+///\r
#define MAX_ADDRESS 0xFFFFFFFFFFFFFFFFULL\r
\r
-//\r
-// The stack alignment required for x64\r
-//\r
+///\r
+/// The stack alignment required for x64\r
+///\r
#define CPU_STACK_ALIGNMENT 16\r
\r
//\r
// Modifier to ensure that all protocol member functions and EFI intrinsics\r
// use the correct C calling convention. All protocol member functions and\r
-// EFI intrinsics are required to modify thier member functions with EFIAPI.\r
+// EFI intrinsics are required to modify their member functions with EFIAPI.\r
//\r
#if _MSC_EXTENSIONS \r
///\r
- /// Define the standard calling convention reguardless of optimization level.\r
- /// __cdecl is Microsoft* specific C extension.\r
+ /// Microsoft* compiler specific method for EFIAPI calling convension\r
/// \r
#define EFIAPI __cdecl \r
#elif __GNUC__\r
// 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
projects / mirror_edk2.git / commitdiff