2 Processor or Compiler specific defines and types x64 (Intel 64, AMD64).
4 Copyright (c) 2006 - 2009, Intel Corporation<BR>
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
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.
15 #ifndef __PROCESSOR_BIND_H__
16 #define __PROCESSOR_BIND_H__
19 /// Define the processor type so other code can make processor based choices
24 // Make sure we are using the correct packing rules per EFI specification
26 #if !defined(__GNUC__)
31 #if defined(__INTEL_COMPILER)
33 // Disable ICC's remark #869: "Parameter" was never referenced warning.
34 // This is legal ANSI C code so we disable the remark that is turned on with -Wall
36 #pragma warning ( disable : 869 )
39 // Disable ICC's remark #1418: external function definition with no prior declaration.
40 // This is legal ANSI C code so we disable the remark that is turned on with /W4
42 #pragma warning ( disable : 1418 )
45 // Disable ICC's remark #1419: external declaration in primary source file
46 // This is legal ANSI C code so we disable the remark that is turned on with /W4
48 #pragma warning ( disable : 1419 )
53 #if defined(_MSC_EXTENSIONS)
56 // Disable warning that make it impossible to compile at /W4
57 // This only works for Microsoft* tools
61 // Disabling bitfield type checking warnings.
63 #pragma warning ( disable : 4214 )
66 // Disabling the unreferenced formal parameter warnings.
68 #pragma warning ( disable : 4100 )
71 // Disable slightly different base types warning as CHAR8 * can not be set
72 // to a constant string.
74 #pragma warning ( disable : 4057 )
77 // ASSERT(FALSE) or while (TRUE) are legal constructes so supress this warning
79 #pragma warning ( disable : 4127 )
82 // This warning is caused by functions defined but not used. For precompiled header only.
84 #pragma warning ( disable : 4505 )
87 // This warning is caused by empty (after preprocessing) source file. For precompiled header only.
89 #pragma warning ( disable : 4206 )
94 #if !defined(__GNUC__) && (__STDC_VERSION__ < 199901L)
96 // No ANSI C 2000 stdint.h integer width declarations, so define equivalents
99 #if defined(_MSC_EXTENSIONS)
101 // use Microsoft C complier dependent integer width types
105 /// 8-byte unsigned value
107 typedef unsigned __int64 UINT64
;
109 /// 8-byte signed value
111 typedef __int64 INT64
;
113 /// 4-byte unsigned value
115 typedef unsigned __int32 UINT32
;
117 /// 4-byte signed value
119 typedef __int32 INT32
;
121 /// 2-byte unsigned value
123 typedef unsigned short UINT16
;
125 /// 2-byte Character. Unless otherwise specified all strings are stored in the
126 /// UTF-16 encoding format as defined by Unicode 2.1 and ISO/IEC 10646 standards.
128 typedef unsigned short CHAR16
;
130 /// 2-byte signed value
134 /// Logical Boolean. 1-byte value containing 0 for FALSE or a 1 for TRUE. Other
135 /// values are undefined.
137 typedef unsigned char BOOLEAN
;
139 /// 1-byte unsigned value
141 typedef unsigned char UINT8
;
147 /// 1-byte signed value
151 #if defined(_EFI_P64)
153 // P64 - pointers being 64-bit and longs and ints are 32-bits.
157 /// 8-byte unsigned value
159 typedef unsigned long long UINT64
;
161 /// 8-byte signed value
163 typedef long long INT64
;
165 /// 4-byte unsigned value
167 typedef unsigned int UINT32
;
169 /// 4-byte signed value
173 /// 2-byte Character. Unless otherwise specified all strings are stored in the
174 /// UTF-16 encoding format as defined by Unicode 2.1 and ISO/IEC 10646 standards.
176 typedef unsigned short CHAR16
;
178 /// 2-byte unsigned value
180 typedef unsigned short UINT16
;
182 /// 2-byte signed value
186 /// Logical Boolean. 1-byte value containing 0 for FALSE or a 1 for TRUE. Other
187 /// values are undefined.
189 typedef unsigned char BOOLEAN
;
191 /// 1-byte unsigned value
193 typedef unsigned char UINT8
;
199 /// 1-byte signed value
204 // Assume LP64 - longs and pointers are 64-bit. Ints are 32-bit.
208 /// 8-byte unsigned value
210 typedef unsigned long UINT64
;
212 /// 8-byte signed value
216 /// 4-byte unsigned value
218 typedef unsigned int UINT32
;
220 /// 4-byte signed value
224 /// 2-byte unsigned value
226 typedef unsigned short UINT16
;
228 /// 2-byte Character. Unless otherwise specified all strings are stored in the
229 /// UTF-16 encoding format as defined by Unicode 2.1 and ISO/IEC 10646 standards.
231 typedef unsigned short CHAR16
;
233 /// 2-byte signed value
237 /// Logical Boolean. 1-byte value containing 0 for FALSE or a 1 for TRUE. Other
238 /// values are undefined.
240 typedef unsigned char BOOLEAN
;
242 /// 1-byte unsigned value
244 typedef unsigned char UINT8
;
250 /// 1-byte signed value
257 // Use ANSI C 2000 stdint.h integer width declarations
262 /// Logical Boolean. 1-byte value containing 0 for FALSE or a 1 for TRUE. Other
263 /// values are undefined.
265 typedef uint8_t BOOLEAN
;
267 /// 1-byte signed value
271 /// 1-byte unsigned value
273 typedef uint8_t UINT8
;
275 /// 2-byte signed value
277 typedef int16_t INT16
;
279 /// 2-byte unsigned value
281 typedef uint16_t UINT16
;
283 /// 4-byte signed value
285 typedef int32_t INT32
;
287 /// 4-byte unsigned value
289 typedef uint32_t UINT32
;
291 /// 8-byte signed value
293 typedef int64_t INT64
;
295 /// 8-byte unsigned value
297 typedef uint64_t UINT64
;
303 /// 2-byte Character. Unless otherwise specified all strings are stored in the
304 /// UTF-16 encoding format as defined by Unicode 2.1 and ISO/IEC 10646 standards.
306 typedef uint16_t CHAR16
;
311 /// Unsigned value of native width. (4 bytes on supported 32-bit processor instructions,
312 /// 8 bytes on supported 64-bit processor instructions)
314 typedef UINT64 UINTN
;
316 /// Signed value of native width. (4 bytes on supported 32-bit processor instructions,
317 /// 8 bytes on supported 64-bit processor instructions)
323 // Processor specific defines
327 /// A value of native width with the highest bit set.
329 #define MAX_BIT 0x8000000000000000ULL
331 /// A value of native width with the two highest bits set.
333 #define MAX_2_BITS 0xC000000000000000ULL
336 /// Maximum legal x64 address
338 #define MAX_ADDRESS 0xFFFFFFFFFFFFFFFFULL
341 /// The stack alignment required for x64
343 #define CPU_STACK_ALIGNMENT 16
346 // Modifier to ensure that all protocol member functions and EFI intrinsics
347 // use the correct C calling convention. All protocol member functions and
348 // EFI intrinsics are required to modify their member functions with EFIAPI.
352 /// If EFIAPI is already defined, then we use that definition.
354 #elif defined(_MSC_EXTENSIONS)
356 /// Microsoft* compiler specific method for EFIAPI calling convension
358 #define EFIAPI __cdecl
359 #elif defined(__GNUC__)
361 /// Define the standard calling convention reguardless of optimization level.
362 /// The GCC support assumes a GCC compiler that supports the EFI ABI. The EFI
363 /// ABI is much closer to the x64 Microsoft* ABI than standard x64 (x86-64)
364 /// GCC ABI. Thus a standard x64 (x86-64) GCC compiler can not be used for
365 /// x64. Warning the assembly code in the MDE x64 does not follow the correct
366 /// ABI for the standard x64 (x86-64) GCC.
371 /// The default for a non Microsoft* or GCC compiler is to assume the EFI ABI
378 // For symbol name in GNU assembly code, an extra "_" is necessary
380 #if defined(__GNUC__)
382 /// For GNU assembly code, .global or .globl can declare global symbols.
383 /// Define this macro to unify the usage.
385 #define ASM_GLOBAL .globl
389 Return the pointer to the first instruction of a function given a function pointer.
390 On x64 CPU architectures, these two pointer values are the same,
391 so the implementation of this macro is very simple.
393 @param FunctionPointer A pointer to a function.
395 @return The pointer to the first instruction of a function given a function pointer.
398 #define FUNCTION_ENTRY_POINT(FunctionPointer) (VOID *)(UINTN)(FunctionPointer)