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