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