BaseTools/Source/C/Include/X64/ProcessorBind.h

   1 /** @file
   2   Processor or Compiler specific defines and types x64 (Intel(r) EM64T, AMD64).
   3
   4   Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>
   5
   6   This program and the accompanying materials are licensed and made available
   7   under the terms and conditions of the BSD License which accompanies this
   8   distribution.  The full text of the license may be found at:
   9     http://opensource.org/licenses/bsd-license.php
  10
  11   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14   File Name:  ProcessorBind.h
  15
  16 **/
  17
  18 #ifndef __PROCESSOR_BIND_H__
  19 #define __PROCESSOR_BIND_H__
  20
  21 //
  22 // Define the processor type so other code can make processor based choices
  23 //
  24 #define MDE_CPU_X64
  25
  26
  27 //
  28 // Make sure we are useing the correct packing rules per EFI specification
  29 //
  30 #ifndef __GNUC__
  31 #pragma pack()
  32 #endif
  33
  34
  35 #if _MSC_EXTENSIONS
  36
  37 //
  38 // Disable warning that make it impossible to compile at /W4
  39 // This only works for Microsoft* tools
  40 //
  41
  42 //
  43 // Disabling bitfield type checking warnings.
  44 //
  45 #pragma warning ( disable : 4214 )
  46
  47 //
  48 // Disabling the unreferenced formal parameter warnings.
  49 //
  50 #pragma warning ( disable : 4100 )
  51
  52 //
  53 // Disable slightly different base types warning as CHAR8 * can not be set
  54 // to a constant string.
  55 //
  56 #pragma warning ( disable : 4057 )
  57
  58 //
  59 // ASSERT(FALSE) or while (TRUE) are legal constructes so supress this warning
  60 //
  61 #pragma warning ( disable : 4127 )
  62
  63
  64 #endif
  65
  66
  67 #if !defined(__GNUC__) && (__STDC_VERSION__ < 199901L)
  68   //
  69   // No ANSI C 2000 stdint.h integer width declarations, so define equivalents
  70   //
  71
  72   #if _MSC_EXTENSIONS
  73
  74
  75     //
  76     // use Microsoft C complier dependent interger width types
  77     //
  78     typedef unsigned __int64    UINT64;
  79     typedef __int64             INT64;
  80     typedef unsigned __int32    UINT32;
  81     typedef __int32             INT32;
  82     typedef unsigned short      UINT16;
  83     typedef unsigned short      CHAR16;
  84     typedef short               INT16;
  85     typedef unsigned char       BOOLEAN;
  86     typedef unsigned char       UINT8;
  87     typedef char                CHAR8;
  88     typedef char                INT8;
  89   #else
  90     #ifdef _EFI_P64
  91       //
  92       // P64 - is Intel Itanium(TM) speak for pointers being 64-bit and longs and ints
  93       //  are 32-bits
  94       //
  95       typedef unsigned long long  UINT64;
  96       typedef long long           INT64;
  97       typedef unsigned int        UINT32;
  98       typedef int                 INT32;
  99       typedef unsigned short      CHAR16;
 100       typedef unsigned short      UINT16;
 101       typedef short               INT16;
 102       typedef unsigned char       BOOLEAN;
 103       typedef unsigned char       UINT8;
 104       typedef char                CHAR8;
 105       typedef char                INT8;
 106     #else
 107       //
 108       // Assume LP64 - longs and pointers are 64-bit. Ints are 32-bit.
 109       //
 110       typedef unsigned long   UINT64;
 111       typedef long            INT64;
 112       typedef unsigned int    UINT32;
 113       typedef int             INT32;
 114       typedef unsigned short  UINT16;
 115       typedef unsigned short  CHAR16;
 116       typedef short           INT16;
 117       typedef unsigned char   BOOLEAN;
 118       typedef unsigned char   UINT8;
 119       typedef char            CHAR8;
 120       typedef char            INT8;
 121     #endif
 122   #endif
 123
 124   #define UINT8_MAX 0xff
 125
 126 #else
 127   //
 128   // Use ANSI C 2000 stdint.h integer width declarations
 129   //
 130   #include <stdint.h>
 131   typedef uint8_t   BOOLEAN;
 132   typedef int8_t    INT8;
 133   typedef uint8_t   UINT8;
 134   typedef int16_t   INT16;
 135   typedef uint16_t  UINT16;
 136   typedef int32_t   INT32;
 137   typedef uint32_t  UINT32;
 138   typedef int64_t   INT64;
 139   typedef uint64_t  UINT64;
 140   typedef char      CHAR8;
 141   typedef uint16_t  CHAR16;
 142
 143 #endif
 144
 145 typedef UINT64  UINTN;
 146 typedef INT64   INTN;
 147
 148
 149 //
 150 // Processor specific defines
 151 //
 152 #define MAX_BIT     0x8000000000000000
 153 #define MAX_2_BITS  0xC000000000000000
 154
 155 //
 156 // Maximum legal Itanium-based address
 157 //
 158 #define MAX_ADDRESS   0xFFFFFFFFFFFFFFFF
 159
 160 //
 161 // Modifier to ensure that all protocol member functions and EFI intrinsics
 162 // use the correct C calling convention. All protocol member functions and
 163 // EFI intrinsics are required to modify thier member functions with EFIAPI.
 164 //
 165 #if _MSC_EXTENSIONS
 166   ///
 167   /// Define the standard calling convention reguardless of optimization level.
 168   /// __cdecl is Microsoft* specific C extension.
 169   ///
 170   #define EFIAPI __cdecl
 171 #elif __GNUC__
 172   ///
 173   /// Define the standard calling convention reguardless of optimization level.
 174   /// efidecl is an extension to GCC that supports the differnece between x64
 175   /// GCC ABI and x64 Microsoft* ABI. EFI is closer to the Microsoft* ABI and
 176   /// EFIAPI makes sure the right ABI is used for public interfaces.
 177   /// eficecl is a work in progress and we do not yet have the compiler
 178   ///
 179   #define EFIAPI
 180 #else
 181   #define EFIAPI
 182 #endif
 183
 184 //
 185 // The Microsoft* C compiler can removed references to unreferenced data items
 186 //  if the /OPT:REF linker option is used. We defined a macro as this is a
 187 //  a non standard extension
 188 //
 189 #if _MSC_EXTENSIONS
 190   #define GLOBAL_REMOVE_IF_UNREFERENCED __declspec(selectany)
 191 #else
 192   #define GLOBAL_REMOVE_IF_UNREFERENCED
 193 #endif
 194
 195 #endif
 196