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
  32 #if __INTEL_COMPILER
  33 //
  34 // Disable ICC's remark #1418: external function definition with no prior declaration.
  35 // This is legal ANSI C code so we disable the remark that is turned on with /W4
  36 //
  37 #pragma warning ( disable : 1418 )
  38
  39
  40 //
  41 // Disable ICC's remark #1419: external declaration in primary source file
  42 // This is legal ANSI C code so we disable the remark that is turned on with /W4
  43 //
  44 #pragma warning ( disable : 1419 )
  45
  46 #endif
  47
  48
  49 #if _MSC_EXTENSIONS
  50
  51 //
  52 // Disable warning that make it impossible to compile at /W4
  53 // This only works for Microsoft* tools
  54 //
  55
  56 //
  57 // Disabling bitfield type checking warnings.
  58 //
  59 #pragma warning ( disable : 4214 )
  60
  61 //
  62 // Disabling the unreferenced formal parameter warnings.
  63 //
  64 #pragma warning ( disable : 4100 )
  65
  66 //
  67 // Disable slightly different base types warning as CHAR8 * can not be set
  68 // to a constant string.
  69 //
  70 #pragma warning ( disable : 4057 )
  71
  72 //
  73 // ASSERT(FALSE) or while (TRUE) are legal constructes so supress this warning
  74 //
  75 #pragma warning ( disable : 4127 )
  76
  77 //
  78 // This warning is caused by functions defined but not used. For precompiled header only.
  79 //
  80 #pragma warning ( disable : 4505 )
  81
  82 //
  83 // This warning is caused by empty (after preprocessing) souce file. For precompiled header only.
  84 //
  85 #pragma warning ( disable : 4206 )
  86
  87 #endif
  88
  89
  90 #if !defined(__GNUC__) && (__STDC_VERSION__ < 199901L)
  91   //
  92   // No ANSI C 2000 stdint.h integer width declarations, so define equivalents
  93   //
  94
  95   #if _MSC_EXTENSIONS
  96
  97
  98     //
  99     // use Microsoft C complier dependent interger width types
 100     //
 101     typedef unsigned __int64    UINT64;
 102     typedef __int64             INT64;
 103     typedef unsigned __int32    UINT32;
 104     typedef __int32             INT32;
 105     typedef unsigned short      UINT16;
 106     typedef unsigned short      CHAR16;
 107     typedef short               INT16;
 108     typedef unsigned char       BOOLEAN;
 109     typedef unsigned char       UINT8;
 110     typedef char                CHAR8;
 111     typedef char                INT8;
 112   #else
 113     #ifdef _EFI_P64
 114       //
 115       // P64 - is Intel Itanium(TM) speak for pointers being 64-bit and longs and ints
 116       //  are 32-bits
 117       //
 118       typedef unsigned long long  UINT64;
 119       typedef long long           INT64;
 120       typedef unsigned int        UINT32;
 121       typedef int                 INT32;
 122       typedef unsigned short      CHAR16;
 123       typedef unsigned short      UINT16;
 124       typedef short               INT16;
 125       typedef unsigned char       BOOLEAN;
 126       typedef unsigned char       UINT8;
 127       typedef char                CHAR8;
 128       typedef char                INT8;
 129     #else
 130       //
 131       // Assume LP64 - longs and pointers are 64-bit. Ints are 32-bit.
 132       //
 133       typedef unsigned long   UINT64;
 134       typedef long            INT64;
 135       typedef unsigned int    UINT32;
 136       typedef int             INT32;
 137       typedef unsigned short  UINT16;
 138       typedef unsigned short  CHAR16;
 139       typedef short           INT16;
 140       typedef unsigned char   BOOLEAN;
 141       typedef unsigned char   UINT8;
 142       typedef char            CHAR8;
 143       typedef char            INT8;
 144     #endif
 145   #endif
 146
 147   #define UINT8_MAX 0xff
 148
 149 #else
 150   //
 151   // Use ANSI C 2000 stdint.h integer width declarations
 152   //
 153   #include <stdint.h>
 154   typedef uint8_t   BOOLEAN;
 155   typedef int8_t    INT8;
 156   typedef uint8_t   UINT8;
 157   typedef int16_t   INT16;
 158   typedef uint16_t  UINT16;
 159   typedef int32_t   INT32;
 160   typedef uint32_t  UINT32;
 161   typedef int64_t   INT64;
 162   typedef uint64_t  UINT64;
 163   typedef char      CHAR8;
 164   typedef uint16_t  CHAR16;
 165
 166 #endif
 167
 168 typedef UINT64  UINTN;
 169 typedef INT64   INTN;
 170
 171
 172 //
 173 // Processor specific defines
 174 //
 175 #define MAX_BIT     0x8000000000000000ULL
 176 #define MAX_2_BITS  0xC000000000000000ULL
 177
 178 //
 179 // Maximum legal X64 address
 180 //
 181 #define MAX_ADDRESS   0xFFFFFFFFFFFFFFFFULL
 182
 183 //
 184 // The stack alignment required for X64
 185 //
 186 #define CPU_STACK_ALIGNMENT   16
 187
 188 //
 189 // Modifier to ensure that all protocol member functions and EFI intrinsics
 190 // use the correct C calling convention. All protocol member functions and
 191 // EFI intrinsics are required to modify thier member functions with EFIAPI.
 192 //
 193 #if _MSC_EXTENSIONS
 194   ///
 195   /// Define the standard calling convention reguardless of optimization level.
 196   /// __cdecl is Microsoft* specific C extension.
 197   ///
 198   #define EFIAPI __cdecl
 199 #elif __GNUC__
 200   ///
 201   /// Define the standard calling convention reguardless of optimization level.
 202   /// The GCC support assumes a GCC compiler that supports the EFI ABI. The EFI
 203   /// ABI is much closer to the x64 Microsoft* ABI than standard x64 (x86-64)
 204   /// GCC ABI. Thus a standard x64 (x86-64) GCC compiler can not be used for
 205   /// x64. Warning the assembly code in the MDE x64 does not follow the correct
 206   /// ABI for the standard x64 (x86-64) GCC.
 207   ///
 208   #define EFIAPI
 209 #else
 210   ///
 211   /// The default for a non Microsoft* or GCC compiler is to assume the EFI ABI
 212   /// is the standard.
 213   ///
 214   #define EFIAPI
 215 #endif
 216
 217 //
 218 // The Microsoft* C compiler can removed references to unreferenced data items
 219 //  if the /OPT:REF linker option is used. We defined a macro as this is a
 220 //  a non standard extension
 221 //
 222 #if _MSC_EXTENSIONS
 223   #define GLOBAL_REMOVE_IF_UNREFERENCED __declspec(selectany)
 224 #else
 225   #define GLOBAL_REMOVE_IF_UNREFERENCED
 226 #endif
 227
 228 //
 229 // For symbol name in GNU assembly code, an extra "_" is necessary
 230 //
 231 #if __GNUC__
 232   #define ASM_PFX(name) _##name
 233 #endif
 234
 235 #endif
 236