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