MdePkg/Include/Ia32/ProcessorBind.h

   1 /** @file
   2   Processor or Compiler specific defines and types for Ia32 architecture.
   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 **/
  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_IA32
  22
  23 //
  24 // Make sure we are useing the correct packing rules per EFI specification
  25 //
  26 #ifndef __GNUC__
  27 #pragma pack()
  28 #endif
  29
  30 #if __INTEL_COMPILER
  31 //
  32 // Disable ICC's remark #593: "LocalVariable" was set but never used
  33 // This is legal ANSI C code so we disable the remark that is turned on with -Wall
  34 //
  35 #pragma warning ( disable : 593 )
  36
  37 //
  38 // Disable ICC's remark #869: "Parameter" was never referenced warning.
  39 // This is legal ANSI C code so we disable the remark that is turned on with -Wall
  40 //
  41 #pragma warning ( disable : 869 )
  42
  43 //
  44 // Disable ICC's remark #1418: external function definition with no prior declaration.
  45 // This is legal ANSI C code so we disable the remark that is turned on with /W4
  46 //
  47 #pragma warning ( disable : 1418 )
  48
  49 //
  50 // Disable ICC's remark #1419: external declaration in primary source file
  51 // This is legal ANSI C code so we disable the remark that is turned on with /W4
  52 //
  53 #pragma warning ( disable : 1419 )
  54
  55 #endif
  56
  57
  58 #if _MSC_EXTENSIONS
  59
  60 //
  61 // Disable warning that make it impossible to compile at /W4
  62 // This only works for Microsoft* tools
  63 //
  64
  65 //
  66 // Disabling bitfield type checking warnings.
  67 //
  68 #pragma warning ( disable : 4214 )
  69
  70 //
  71 // Disabling the unreferenced formal parameter warnings.
  72 //
  73 #pragma warning ( disable : 4100 )
  74
  75 //
  76 // Disable slightly different base types warning as CHAR8 * can not be set
  77 // to a constant string.
  78 //
  79 #pragma warning ( disable : 4057 )
  80
  81 //
  82 // ASSERT(FALSE) or while (TRUE) are legal constructes so supress this warning
  83 //
  84 #pragma warning ( disable : 4127 )
  85
  86 //
  87 // This warning is caused by functions defined but not used. For precompiled header only.
  88 //
  89 #pragma warning ( disable : 4505 )
  90
  91 //
  92 // This warning is caused by empty (after preprocessing) souce file. For precompiled header only.
  93 //
  94 #pragma warning ( disable : 4206 )
  95
  96 #endif
  97
  98
  99 #if !defined(__GNUC__) && (__STDC_VERSION__ < 199901L)
 100   //
 101   // No ANSI C 2000 stdint.h integer width declarations, so define equivalents
 102   //
 103
 104   #if _MSC_EXTENSIONS
 105
 106     //
 107     // use Microsoft* C complier dependent interger width types
 108     //
 109     typedef unsigned __int64    UINT64;
 110     typedef __int64             INT64;
 111     typedef unsigned __int32    UINT32;
 112     typedef __int32             INT32;
 113     typedef unsigned short      UINT16;
 114     typedef unsigned short      CHAR16;
 115     typedef short               INT16;
 116     typedef unsigned char       BOOLEAN;
 117     typedef unsigned char       UINT8;
 118     typedef char                CHAR8;
 119     typedef char                INT8;
 120   #else
 121
 122     //
 123     // Assume standard IA-32 alignment.
 124     // Need to check portability of long long
 125     //
 126     typedef unsigned long long  UINT64;
 127     typedef long long           INT64;
 128     typedef unsigned int        UINT32;
 129     typedef int                 INT32;
 130     typedef unsigned short      UINT16;
 131     typedef unsigned short      CHAR16;
 132     typedef short               INT16;
 133     typedef unsigned char       BOOLEAN;
 134     typedef unsigned char       UINT8;
 135     typedef char                CHAR8;
 136     typedef char                INT8;
 137   #endif
 138
 139   #define UINT8_MAX 0xff
 140
 141 #else
 142   //
 143   // Use ANSI C 2000 stdint.h integer width declarations
 144   //
 145   #include "stdint.h"
 146   typedef uint8_t   BOOLEAN;
 147   typedef int8_t    INT8;
 148   typedef uint8_t   UINT8;
 149   typedef int16_t   INT16;
 150   typedef uint16_t  UINT16;
 151   typedef int32_t   INT32;
 152   typedef uint32_t  UINT32;
 153   typedef int64_t   INT64;
 154   typedef uint64_t  UINT64;
 155   typedef char      CHAR8;
 156   typedef uint16_t  CHAR16;
 157
 158 #endif
 159
 160 typedef UINT32  UINTN;
 161 typedef INT32   INTN;
 162
 163
 164 ///
 165 /// Processor specific defines
 166 ///
 167 #define MAX_BIT     0x80000000
 168 #define MAX_2_BITS  0xC0000000
 169
 170 ///
 171 /// Maximum legal IA-32 address
 172 ///
 173 #define MAX_ADDRESS   0xFFFFFFFF
 174
 175 ///
 176 /// The stack alignment required for IA-32
 177 ///
 178 #define CPU_STACK_ALIGNMENT   sizeof(UINTN)
 179
 180 //
 181 // Modifier to ensure that all protocol member functions and EFI intrinsics
 182 // use the correct C calling convention. All protocol member functions and
 183 // EFI intrinsics are required to modify thier member functions with EFIAPI.
 184 //
 185 #if _MSC_EXTENSIONS
 186   ///
 187   /// Microsoft* compiler requires _EFIAPI useage, __cdecl is Microsoft* specific C.
 188   ///
 189   #define EFIAPI __cdecl
 190 #else
 191   #if __GNUC__
 192     #define EFIAPI __attribute__((cdecl))
 193   #endif
 194 #endif
 195
 196 //
 197 // The Microsoft* C compiler can removed references to unreferenced data items
 198 //  if the /OPT:REF linker option is used. We defined a macro as this is a
 199 //  a non standard extension
 200 //
 201 #if _MSC_EXTENSIONS
 202   #define GLOBAL_REMOVE_IF_UNREFERENCED __declspec(selectany)
 203 #else
 204   #define GLOBAL_REMOVE_IF_UNREFERENCED
 205 #endif
 206
 207 //
 208 // For symbol name in GNU assembly code, an extra "_" is necessary
 209 //
 210 #if __GNUC__
 211   #if defined(linux)
 212     #define ASM_PFX(name) name
 213   #else
 214     #define ASM_PFX(name) _##name
 215   #endif
 216 #endif
 217
 218 #define FUNCTION_ENTRY_POINT(p) (p)
 219
 220 #endif
 221