]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/X64/ProcessorBind.h
Updating processor bindings to not use stdint.h. Also added code to verify at compil...
[mirror_edk2.git] / MdePkg / Include / X64 / ProcessorBind.h
index 3b61a3b826be2a3d64719310e549c0cf7fb239d8..b22d654ae6315b64c0c068c4dc58a3a011e98066 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
-  Processor or Compiler specific defines and types x64 (Intel(r) EM64T, AMD64).\r
+  Processor or Compiler specific defines and types x64 (Intel 64, AMD64).\r
 \r
-  Copyright (c) 2006, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2010, Intel Corporation<BR>                                                         \r
   All rights reserved. This program and the accompanying materials                          \r
   are licensed and made available under the terms and conditions of the BSD License         \r
   which accompanies this distribution.  The full text of the license may be found at        \r
 ///\r
 #define MDE_CPU_X64\r
 \r
-\r
 //\r
-// Make sure we are useing the correct packing rules per EFI specification\r
+// Make sure we are using the correct packing rules per EFI specification\r
 //\r
-#ifndef __GNUC__\r
+#if !defined(__GNUC__)\r
 #pragma pack()\r
 #endif\r
 \r
 \r
-#if __INTEL_COMPILER\r
+#if defined(__INTEL_COMPILER)\r
 //\r
 // Disable ICC's remark #869: "Parameter" was never referenced warning.\r
 // This is legal ANSI C code so we disable the remark that is turned on with -Wall\r
 //\r
 #pragma warning ( disable : 1419 )\r
 \r
+//\r
+// Disable ICC's remark #593: "Variable" was set but never used.\r
+// This is legal ANSI C code so we disable the remark that is turned on with /W4\r
+//\r
+#pragma warning ( disable : 593 )\r
+\r
 #endif\r
 \r
 \r
-#if _MSC_EXTENSIONS\r
+#if defined(_MSC_EXTENSIONS)\r
 \r
 //\r
 // Disable warning that make it impossible to compile at /W4\r
 #pragma warning ( disable : 4505 )\r
 \r
 //\r
-// This warning is caused by empty (after preprocessing) souce file. For precompiled header only.\r
+// This warning is caused by empty (after preprocessing) source file. For precompiled header only.\r
 //\r
 #pragma warning ( disable : 4206 )\r
 \r
 #endif\r
 \r
 \r
-#if !defined(__GNUC__) && (__STDC_VERSION__ < 199901L)\r
+#if defined(_MSC_EXTENSIONS)\r
   //\r
-  // No ANSI C 2000 stdint.h integer width declarations, so define equivalents\r
+  // use Microsoft C complier dependent integer width types \r
   //\r
\r
-  #if _MSC_EXTENSIONS \r
-    //\r
-    // use Microsoft C complier dependent interger width types \r
-    //\r
-    typedef unsigned __int64    UINT64;\r
-    typedef __int64             INT64;\r
-    typedef unsigned __int32    UINT32;\r
-    typedef __int32             INT32;\r
-    typedef unsigned short      UINT16;\r
-    typedef unsigned short      CHAR16;\r
-    typedef short               INT16;\r
-    typedef unsigned char       BOOLEAN;\r
-    typedef unsigned char       UINT8;\r
-    typedef char                CHAR8;\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
-      typedef unsigned long long  UINT64;\r
-      typedef long long           INT64;\r
-      typedef unsigned int        UINT32;\r
-      typedef int                 INT32;\r
-      typedef unsigned short      CHAR16;\r
-      typedef unsigned short      UINT16;\r
-      typedef short               INT16;\r
-      typedef unsigned char       BOOLEAN;\r
-      typedef unsigned char       UINT8;\r
-      typedef char                CHAR8;\r
-      typedef char                INT8;\r
-    #else\r
-      //\r
-      // Assume LP64 - longs and pointers are 64-bit. Ints are 32-bit.\r
-      //\r
-      typedef unsigned long   UINT64;\r
-      typedef long            INT64;\r
-      typedef unsigned int    UINT32;\r
-      typedef int             INT32;\r
-      typedef unsigned short  UINT16;\r
-      typedef unsigned short  CHAR16;\r
-      typedef short           INT16;\r
-      typedef unsigned char   BOOLEAN;\r
-      typedef unsigned char   UINT8;\r
-      typedef char            CHAR8;\r
-      typedef char            INT8;\r
-    #endif\r
-  #endif\r
-\r
-  #define UINT8_MAX 0xff\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
-  // Use ANSI C 2000 stdint.h integer width declarations\r
-  //\r
-  #include <stdint.h>\r
-  typedef uint8_t   BOOLEAN;\r
-  typedef int8_t    INT8;\r
-  typedef uint8_t   UINT8;\r
-  typedef int16_t   INT16;\r
-  typedef uint16_t  UINT16;\r
-  typedef int32_t   INT32;\r
-  typedef uint32_t  UINT32;\r
-  typedef int64_t   INT64;\r
-  typedef uint64_t  UINT64;\r
-  typedef char      CHAR8;\r
-  typedef uint16_t  CHAR16;\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
+///\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
+#ifdef EFIAPI\r
   ///\r
-  /// Define the standard calling convention reguardless of optimization level.\r
-  /// __cdecl is Microsoft* specific C extension.\r
+  /// If EFIAPI is already defined, then we use that definition.\r
+  ///\r
+#elif defined(_MSC_EXTENSIONS)\r
+  ///\r
+  /// Microsoft* compiler specific method for EFIAPI calling convension\r
   /// \r
   #define EFIAPI __cdecl  \r
-#elif __GNUC__\r
+#elif defined(__GNUC__)\r
   ///\r
   /// Define the standard calling convention reguardless of optimization level.\r
   /// The GCC support assumes a GCC compiler that supports the EFI ABI. The EFI\r
@@ -216,29 +264,25 @@ typedef INT64   INTN;
   #define EFIAPI       \r
 #endif\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
-//  a non standard extension\r
-//\r
-#if _MSC_EXTENSIONS\r
-  #define GLOBAL_REMOVE_IF_UNREFERENCED __declspec(selectany)\r
-#else\r
-  #define GLOBAL_REMOVE_IF_UNREFERENCED\r
+#if defined(__GNUC__)\r
+  ///\r
+  /// For GNU assembly code, .global or .globl can declare global symbols.\r
+  /// Define this macro to unify the usage.\r
+  ///\r
+  #define ASM_GLOBAL .globl\r
 #endif\r
 \r
-//\r
-// For symbol name in GNU assembly code, an extra "_" is necessary\r
-//\r
-#if __GNUC__\r
-  #if defined(linux)\r
-    #define ASM_PFX(name) name\r
-  #else\r
-    #define ASM_PFX(name) _##name\r
-  #endif  \r
-#endif\r
+/**\r
+  Return the pointer to the first instruction of a function given a function pointer.\r
+  On x64 CPU architectures, these two pointer values are the same, \r
+  so the implementation of this macro is very simple.\r
+  \r
+  @param  FunctionPointer   A pointer to a function.\r
 \r
-#define FUNCTION_ENTRY_POINT(p) (p)\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
 \r