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