EdkCompatibilityPkg/Foundation/Include/Ia32/EfiBind.h

   1 /*++
   2
   3 Copyright (c) 2004 - 2008, Intel Corporation
   4 All rights reserved. This program and the accompanying materials
   5 are licensed and made available under the terms and conditions of the BSD License
   6 which accompanies this distribution.  The full text of the license may be found at
   7 http://opensource.org/licenses/bsd-license.php
   8
   9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  11
  12 Module Name:
  13
  14   EfiBind.h
  15
  16 Abstract:
  17
  18   Processor or Compiler specific defines and types for IA-32.
  19   We are using the ANSI C 2000 _t type definitions for basic types.
  20   This it technically a violation of the coding standard, but they
  21   are used to make EfiTypes.h portable. Code other than EfiTypes.h
  22   should never use any ANSI C 2000 _t integer types.
  23
  24 --*/
  25
  26 #ifndef _EFI_BIND_H_
  27 #define _EFI_BIND_H_
  28
  29 #ifdef EFI_DEBUG
  30
  31 #ifdef EFI_NT_EMULATOR
  32
  33 #define EFI_DRIVER_ENTRY_POINT(InitFunction)                  \
  34           EFI_STATUS                                          \
  35           EFIAPI                                              \
  36           InitFunction (                                      \
  37             EFI_HANDLE        ImageHandle,                    \
  38             EFI_SYSTEM_TABLE  *SystemTable                    \
  39             );                                                \
  40                                                               \
  41           UINTN                                               \
  42           __stdcall                                           \
  43           _DllMainCRTStartup (                                \
  44               UINTN    Inst,                                  \
  45               UINTN    reason_for_call,                       \
  46               VOID    *rserved                                \
  47               )                                               \
  48           {                                                   \
  49               return 1;                                       \
  50           }                                                   \
  51                                                               \
  52           EFI_STATUS                                          \
  53           __declspec( dllexport  )                            \
  54           __cdecl                                             \
  55           InitializeDriver (                                  \
  56               EFI_HANDLE       ImageHandle,                   \
  57               EFI_SYSTEM_TABLE *SystemTable                   \
  58               )                                               \
  59           {                                                   \
  60               return InitFunction(ImageHandle, SystemTable);  \
  61           }
  62
  63 #define EFI_APPLICATION_ENTRY_POINT EFI_DRIVER_ENTRY_POINT
  64
  65 #else
  66
  67 #define EFI_DRIVER_ENTRY_POINT(InitFunction)
  68 #define EFI_APPLICATION_ENTRY_POINT EFI_DRIVER_ENTRY_POINT
  69
  70 #endif
  71
  72 #else
  73
  74 #define EFI_DRIVER_ENTRY_POINT(InitFunction)
  75 #define EFI_APPLICATION_ENTRY_POINT EFI_DRIVER_ENTRY_POINT
  76
  77 #endif
  78
  79
  80
  81
  82
  83 //
  84 // Make sure we are useing the correct packing rules per EFI specification
  85 //
  86 #pragma pack()
  87
  88 #if __INTEL_COMPILER
  89 //
  90 // Disable ICC's warning: trailing comma is nonstandard
  91 //
  92 //#pragma warning ( disable : 271 )
  93
  94 //
  95 // Disable ICC's warning: extra ";" ignored
  96 //
  97 #pragma warning ( disable : 424 )
  98
  99 //
 100 // Disable ICC's warning: : variable "foo" was set but never used
 101 //
 102 #pragma warning ( disable : 593 )
 103
 104 //
 105 // Disable ICC's remark #1418: external function definition with no prior declaration.
 106 // This is legal ANSI C code so we disable the remark that is turned on with /W4
 107 //
 108 #pragma warning ( disable : 1418 )
 109
 110
 111 //
 112 // Disable ICC's remark #1419: external declaration in primary source file
 113 // This is legal ANSI C code so we disable the remark that is turned on with /W4
 114 //
 115 #pragma warning ( disable : 1419 )
 116
 117 #endif
 118
 119
 120 #if _MSC_EXTENSIONS
 121
 122 //
 123 // Disable warning that make it impossible to compile at /W4
 124 // This only works for Microsoft* tools
 125 //
 126
 127 //
 128 // Disabling bitfield type checking warnings.
 129 //
 130 #pragma warning ( disable : 4214 )
 131
 132 //
 133 // Disabling the unreferenced formal parameter warnings.
 134 //
 135 #pragma warning ( disable : 4100 )
 136
 137 //
 138 // Disable slightly different base types warning as CHAR8 * can not be set
 139 // to a constant string.
 140 //
 141 #pragma warning ( disable : 4057 )
 142
 143 //
 144 // ASSERT(FALSE) or while (TRUE) are legal constructes so supress this warning
 145 //
 146 #pragma warning ( disable : 4127 )
 147
 148 //
 149 // Int64ShllMod32 unreferenced inline function
 150 //
 151 #pragma warning ( disable : 4514 )
 152
 153 //
 154 // Unreferenced formal parameter - We are object oriented, so we pass This even
 155 //  if we  don't need them.
 156 //
 157 #pragma warning ( disable : 4100 )
 158
 159 //
 160 // This warning is caused by empty (after preprocessing) souce file.
 161 //
 162 #pragma warning ( disable : 4206 )
 163
 164
 165 #endif
 166
 167
 168 #if !defined(__GNUC__) && (__STDC_VERSION__ < 199901L)
 169   //
 170   // No ANSI C 2000 stdint.h integer width declarations, so define equivalents
 171   //
 172
 173   #if _MSC_EXTENSIONS
 174
 175     //
 176     // use Microsoft* C complier dependent interger width types
 177     //
 178     typedef unsigned __int64    uint64_t;
 179     typedef __int64             int64_t;
 180     typedef unsigned __int32    uint32_t;
 181     typedef __int32             int32_t;
 182     typedef unsigned short      uint16_t;
 183     typedef short               int16_t;
 184     typedef unsigned char       uint8_t;
 185     typedef char                int8_t;
 186   #else
 187
 188     //
 189     // Assume standard IA-32 alignment.
 190     // BugBug: Need to check portability of long long
 191     //
 192     typedef unsigned long long  uint64_t;
 193     typedef long long           int64_t;
 194     typedef unsigned int        uint32_t;
 195     typedef int                 int32_t;
 196     typedef unsigned short      uint16_t;
 197     typedef short               int16_t;
 198     typedef unsigned char       uint8_t;
 199     typedef char                int8_t;
 200   #endif
 201 #else
 202   //
 203   // Use ANSI C 2000 stdint.h integer width declarations
 204   //
 205   #include "stdint.h"
 206 #endif
 207
 208 //
 209 // Native integer size in stdint.h
 210 //
 211 typedef uint32_t  uintn_t;
 212 typedef int32_t   intn_t;
 213
 214 //
 215 // Processor specific defines
 216 //
 217 #define EFI_MAX_BIT       0x80000000
 218 #define MAX_2_BITS        0xC0000000
 219
 220 //
 221 // Maximum legal IA-32 address
 222 //
 223 #define EFI_MAX_ADDRESS   0xFFFFFFFF
 224
 225 //
 226 //  Bad pointer value to use in check builds.
 227 //  if you see this value you are using uninitialized or free'ed data
 228 //
 229 #define EFI_BAD_POINTER          0xAFAFAFAF
 230 #define EFI_BAD_POINTER_AS_BYTE  0xAF
 231
 232 //
 233 // Inject a break point in the code to assist debugging for NT Emulation Environment
 234 // For real hardware, just put in a halt loop. Don't do a while(1) because the
 235 // compiler will optimize away the rest of the function following, so that you run out in
 236 // the weeds if you skip over it with a debugger.
 237 //
 238 #define EFI_BREAKPOINT()  __asm { int 3 }
 239 #define EFI_DEADLOOP()    { volatile UINTN __iii; __iii = 1; while (__iii); }
 240
 241 //
 242 // Memory Fence forces serialization, and is needed to support out of order
 243 //  memory transactions. The Memory Fence is mainly used to make sure IO
 244 //  transactions complete in a deterministic sequence, and to syncronize locks
 245 //  an other MP code. Currently no memory fencing is required.
 246 //
 247 #define MEMORY_FENCE()
 248
 249 //
 250 // Some compilers don't support the forward reference construct:
 251 //  typedef struct XXXXX. The forward reference is required for
 252 //  ANSI compatibility.
 253 //
 254 // The following macro provide a workaround for such cases.
 255 //
 256
 257
 258 #ifdef EFI_NO_INTERFACE_DECL
 259   #define EFI_FORWARD_DECLARATION(x)
 260 #else
 261   #define EFI_FORWARD_DECLARATION(x) typedef struct _##x x
 262 #endif
 263
 264
 265 //
 266 // Some C compilers optimize the calling conventions to increase performance.
 267 // _EFIAPI is used to make all public APIs follow the standard C calling
 268 // convention.
 269 //
 270 #if _MSC_EXTENSIONS
 271   //
 272   // Microsoft* compiler requires _EFIAPI useage, __cdecl is Microsoft* specific C.
 273   //
 274
 275   #define _EFIAPI __cdecl
 276 #else
 277   #define _EFIAPI
 278 #endif
 279
 280
 281 #ifdef _EFI_WINNT
 282
 283   #define EFI_SUPPRESS_BENIGN_REDEFINITION_OF_TYPE_WARNING()  \
 284            warning ( disable : 4142 )
 285
 286   #define EFI_DEFAULT_BENIGN_REDEFINITION_OF_TYPE_WARNING()  \
 287            warning ( default : 4142 )
 288 #else
 289
 290   #define EFI_SUPPRESS_BENIGN_REDEFINITION_OF_TYPE_WARNING()  \
 291            warning ( disable : 4068 )
 292
 293   #define EFI_DEFAULT_BENIGN_REDEFINITION_OF_TYPE_WARNING()  \
 294            warning ( default : 4068 )
 295
 296 #endif
 297
 298
 299
 300 #endif
 301