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