MdePkg/Include/x64/ProcessorBind.h

   1 /** @file
   2   Processor or Compiler specific defines and types x64 (Intel(r) EM64T, AMD64).
   3
   4   Copyright (c) 2006, Intel Corporation
   5   All rights reserved. This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef __PROCESSOR_BIND_H__
  16 #define __PROCESSOR_BIND_H__
  17
  18 //
  19 // Define the processor type so other code can make processor based choices
  20 //
  21 #define MDE_CPU_X64
  22
  23
  24 //
  25 // Make sure we are useing the correct packing rules per EFI specification
  26 //
  27 #ifndef __GNUC__
  28 #pragma pack()
  29 #endif
  30
  31 #if _MSC_EXTENSIONS
  32
  33 //
  34 // Disable warning that make it impossible to compile at /W4
  35 // This only works for Microsoft* tools
  36 //
  37
  38 //
  39 // Disabling bitfield type checking warnings.
  40 //
  41 #pragma warning ( disable : 4214 )
  42
  43 //
  44 // Disabling the unreferenced formal parameter warnings.
  45 //
  46 #pragma warning ( disable : 4100 )
  47
  48 //
  49 // Disable slightly different base types warning as CHAR8 * can not be set
  50 // to a constant string.
  51 //
  52 #pragma warning ( disable : 4057 )
  53
  54 //
  55 // ASSERT(FALSE) or while (TRUE) are legal constructes so supress this warning
  56 //
  57 #pragma warning ( disable : 4127 )
  58
  59 //
  60 // This warning is caused by functions defined but not used. For precompiled header only.
  61 //
  62 #pragma warning ( disable : 4505 )
  63
  64 //
  65 // This warning is caused by empty (after preprocessing) souce file. For precompiled header only.
  66 //
  67 #pragma warning ( disable : 4206 )
  68
  69 #endif
  70
  71
  72 #if !defined(__GNUC__) && (__STDC_VERSION__ < 199901L)
  73   //
  74   // No ANSI C 2000 stdint.h integer width declarations, so define equivalents
  75   //
  76
  77   #if _MSC_EXTENSIONS
  78
  79
  80     //
  81     // use Microsoft C complier dependent interger width types
  82     //
  83     typedef unsigned __int64    UINT64;
  84     typedef __int64             INT64;
  85     typedef unsigned __int32    UINT32;
  86     typedef __int32             INT32;
  87     typedef unsigned short      UINT16;
  88     typedef unsigned short      CHAR16;
  89     typedef short               INT16;
  90     typedef unsigned char       BOOLEAN;
  91     typedef unsigned char       UINT8;
  92     typedef char                CHAR8;
  93     typedef char                INT8;
  94   #else
  95     #ifdef _EFI_P64
  96       //
  97       // P64 - is Intel Itanium(TM) speak for pointers being 64-bit and longs and ints
  98       //  are 32-bits
  99       //
 100       typedef unsigned long long  UINT64;
 101       typedef long long           INT64;
 102       typedef unsigned int        UINT32;
 103       typedef int                 INT32;
 104       typedef unsigned short      CHAR16;
 105       typedef unsigned short      UINT16;
 106       typedef short               INT16;
 107       typedef unsigned char       BOOLEAN;
 108       typedef unsigned char       UINT8;
 109       typedef char                CHAR8;
 110       typedef char                INT8;
 111     #else
 112       //
 113       // Assume LP64 - longs and pointers are 64-bit. Ints are 32-bit.
 114       //
 115       typedef unsigned long   UINT64;
 116       typedef long            INT64;
 117       typedef unsigned int    UINT32;
 118       typedef int             INT32;
 119       typedef unsigned short  UINT16;
 120       typedef unsigned short  CHAR16;
 121       typedef short           INT16;
 122       typedef unsigned char   BOOLEAN;
 123       typedef unsigned char   UINT8;
 124       typedef char            CHAR8;
 125       typedef char            INT8;
 126     #endif
 127   #endif
 128
 129   #define UINT8_MAX 0xff
 130
 131 #else
 132   //
 133   // Use ANSI C 2000 stdint.h integer width declarations
 134   //
 135   #include <stdint.h>
 136   typedef uint8_t   BOOLEAN;
 137   typedef int8_t    INT8;
 138   typedef uint8_t   UINT8;
 139   typedef int16_t   INT16;
 140   typedef uint16_t  UINT16;
 141   typedef int32_t   INT32;
 142   typedef uint32_t  UINT32;
 143   typedef int64_t   INT64;
 144   typedef uint64_t  UINT64;
 145   typedef char      CHAR8;
 146   typedef uint16_t  CHAR16;
 147
 148 #endif
 149
 150 typedef UINT64  UINTN;
 151 typedef INT64   INTN;
 152
 153
 154 //
 155 // Processor specific defines
 156 //
 157 #define MAX_BIT     0x8000000000000000ULL
 158 #define MAX_2_BITS  0xC000000000000000ULL
 159
 160 //
 161 // Maximum legal X64 address
 162 //
 163 #define MAX_ADDRESS   0xFFFFFFFFFFFFFFFFULL
 164
 165 //
 166 // The stack alignment required for X64
 167 //
 168 #define CPU_STACK_ALIGNMENT   16
 169
 170 //
 171 // Modifier to ensure that all protocol member functions and EFI intrinsics
 172 // use the correct C calling convention. All protocol member functions and
 173 // EFI intrinsics are required to modify thier member functions with EFIAPI.
 174 //
 175 #if _MSC_EXTENSIONS
 176   ///
 177   /// Define the standard calling convention reguardless of optimization level.
 178   /// __cdecl is Microsoft* specific C extension.
 179   ///
 180   #define EFIAPI __cdecl
 181 #elif __GNUC__
 182   ///
 183   /// Define the standard calling convention reguardless of optimization level.
 184   /// The GCC support assumes a GCC compiler that supports the EFI ABI. The EFI
 185   /// ABI is much closer to the x64 Microsoft* ABI than standard x64 (x86-64)
 186   /// GCC ABI. Thus a standard x64 (x86-64) GCC compiler can not be used for
 187   /// x64. Warning the assembly code in the MDE x64 does not follow the correct
 188   /// ABI for the standard x64 (x86-64) GCC.
 189   ///
 190   #define EFIAPI
 191 #else
 192   ///
 193   /// The default for a non Microsoft* or GCC compiler is to assume the EFI ABI
 194   /// is the standard.
 195   ///
 196   #define EFIAPI
 197 #endif
 198
 199 //
 200 // The Microsoft* C compiler can removed references to unreferenced data items
 201 //  if the /OPT:REF linker option is used. We defined a macro as this is a
 202 //  a non standard extension
 203 //
 204 #if _MSC_EXTENSIONS
 205   #define GLOBAL_REMOVE_IF_UNREFERENCED __declspec(selectany)
 206 #else
 207   #define GLOBAL_REMOVE_IF_UNREFERENCED
 208 #endif
 209
 210 #endif
 211