2 Processor or Compiler specific defines and types x64 (Intel 64, AMD64).
4 Copyright (c) 2006 - 2010, 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 )
51 // Disable ICC's remark #593: "Variable" was set but never used.
52 // This is legal ANSI C code so we disable the remark that is turned on with /W4
54 #pragma warning ( disable : 593 )
59 #if defined(_MSC_EXTENSIONS)
62 // Disable warning that make it impossible to compile at /W4
63 // This only works for Microsoft* tools
67 // Disabling bitfield type checking warnings.
69 #pragma warning ( disable : 4214 )
72 // Disabling the unreferenced formal parameter warnings.
74 #pragma warning ( disable : 4100 )
77 // Disable slightly different base types warning as CHAR8 * can not be set
78 // to a constant string.
80 #pragma warning ( disable : 4057 )
83 // ASSERT(FALSE) or while (TRUE) are legal constructes so supress this warning
85 #pragma warning ( disable : 4127 )
88 // This warning is caused by functions defined but not used. For precompiled header only.
90 #pragma warning ( disable : 4505 )
93 // This warning is caused by empty (after preprocessing) source file. For precompiled header only.
95 #pragma warning ( disable : 4206 )
100 #if !defined(__GNUC__) && (__STDC_VERSION__ < 199901L)
102 // No ANSI C 2000 stdint.h integer width declarations, so define equivalents
105 #if defined(_MSC_EXTENSIONS)
107 // use Microsoft C complier dependent integer width types
111 /// 8-byte unsigned value
113 typedef unsigned __int64 UINT64
;
115 /// 8-byte signed value
117 typedef __int64 INT64
;
119 /// 4-byte unsigned value
121 typedef unsigned __int32 UINT32
;
123 /// 4-byte signed value
125 typedef __int32 INT32
;
127 /// 2-byte unsigned value
129 typedef unsigned short UINT16
;
131 /// 2-byte Character. Unless otherwise specified all strings are stored in the
132 /// UTF-16 encoding format as defined by Unicode 2.1 and ISO/IEC 10646 standards.
134 typedef unsigned short CHAR16
;
136 /// 2-byte signed value
140 /// Logical Boolean. 1-byte value containing 0 for FALSE or a 1 for TRUE. Other
141 /// values are undefined.
143 typedef unsigned char BOOLEAN
;
145 /// 1-byte unsigned value
147 typedef unsigned char UINT8
;
153 /// 1-byte signed value
157 #if defined(_EFI_P64)
159 // P64 - pointers being 64-bit and longs and ints are 32-bits.
163 /// 8-byte unsigned value
165 typedef unsigned long long UINT64
;
167 /// 8-byte signed value
169 typedef long long INT64
;
171 /// 4-byte unsigned value
173 typedef unsigned int UINT32
;
175 /// 4-byte signed value
179 /// 2-byte Character. Unless otherwise specified all strings are stored in the
180 /// UTF-16 encoding format as defined by Unicode 2.1 and ISO/IEC 10646 standards.
182 typedef unsigned short CHAR16
;
184 /// 2-byte unsigned value
186 typedef unsigned short UINT16
;
188 /// 2-byte signed value
192 /// Logical Boolean. 1-byte value containing 0 for FALSE or a 1 for TRUE. Other
193 /// values are undefined.
195 typedef unsigned char BOOLEAN
;
197 /// 1-byte unsigned value
199 typedef unsigned char UINT8
;
205 /// 1-byte signed value
210 // Assume LP64 - longs and pointers are 64-bit. Ints are 32-bit.
214 /// 8-byte unsigned value
216 typedef unsigned long UINT64
;
218 /// 8-byte signed value
222 /// 4-byte unsigned value
224 typedef unsigned int UINT32
;
226 /// 4-byte signed value
230 /// 2-byte unsigned value
232 typedef unsigned short UINT16
;
234 /// 2-byte Character. Unless otherwise specified all strings are stored in the
235 /// UTF-16 encoding format as defined by Unicode 2.1 and ISO/IEC 10646 standards.
237 typedef unsigned short CHAR16
;
239 /// 2-byte signed value
243 /// Logical Boolean. 1-byte value containing 0 for FALSE or a 1 for TRUE. Other
244 /// values are undefined.
246 typedef unsigned char BOOLEAN
;
248 /// 1-byte unsigned value
250 typedef unsigned char UINT8
;
256 /// 1-byte signed value
263 // Use ANSI C 2000 stdint.h integer width declarations
268 /// Logical Boolean. 1-byte value containing 0 for FALSE or a 1 for TRUE. Other
269 /// values are undefined.
271 typedef uint8_t BOOLEAN
;
273 /// 1-byte signed value
277 /// 1-byte unsigned value
279 typedef uint8_t UINT8
;
281 /// 2-byte signed value
283 typedef int16_t INT16
;
285 /// 2-byte unsigned value
287 typedef uint16_t UINT16
;
289 /// 4-byte signed value
291 typedef int32_t INT32
;
293 /// 4-byte unsigned value
295 typedef uint32_t UINT32
;
297 /// 8-byte signed value
299 typedef int64_t INT64
;
301 /// 8-byte unsigned value
303 typedef uint64_t UINT64
;
309 /// 2-byte Character. Unless otherwise specified all strings are stored in the
310 /// UTF-16 encoding format as defined by Unicode 2.1 and ISO/IEC 10646 standards.
312 typedef uint16_t CHAR16
;
317 /// Unsigned value of native width. (4 bytes on supported 32-bit processor instructions,
318 /// 8 bytes on supported 64-bit processor instructions)
320 typedef UINT64 UINTN
;
322 /// Signed value of native width. (4 bytes on supported 32-bit processor instructions,
323 /// 8 bytes on supported 64-bit processor instructions)
329 // Processor specific defines
333 /// A value of native width with the highest bit set.
335 #define MAX_BIT 0x8000000000000000ULL
337 /// A value of native width with the two highest bits set.
339 #define MAX_2_BITS 0xC000000000000000ULL
342 /// Maximum legal x64 address
344 #define MAX_ADDRESS 0xFFFFFFFFFFFFFFFFULL
347 /// The stack alignment required for x64
349 #define CPU_STACK_ALIGNMENT 16
352 // Modifier to ensure that all protocol member functions and EFI intrinsics
353 // use the correct C calling convention. All protocol member functions and
354 // EFI intrinsics are required to modify their member functions with EFIAPI.
358 /// If EFIAPI is already defined, then we use that definition.
360 #elif defined(_MSC_EXTENSIONS)
362 /// Microsoft* compiler specific method for EFIAPI calling convension
364 #define EFIAPI __cdecl
365 #elif defined(__GNUC__)
367 /// Define the standard calling convention reguardless of optimization level.
368 /// The GCC support assumes a GCC compiler that supports the EFI ABI. The EFI
369 /// ABI is much closer to the x64 Microsoft* ABI than standard x64 (x86-64)
370 /// GCC ABI. Thus a standard x64 (x86-64) GCC compiler can not be used for
371 /// x64. Warning the assembly code in the MDE x64 does not follow the correct
372 /// ABI for the standard x64 (x86-64) GCC.
377 /// The default for a non Microsoft* or GCC compiler is to assume the EFI ABI
383 #if defined(__GNUC__)
385 /// For GNU assembly code, .global or .globl can declare global symbols.
386 /// Define this macro to unify the usage.
388 #define ASM_GLOBAL .globl
392 Return the pointer to the first instruction of a function given a function pointer.
393 On x64 CPU architectures, these two pointer values are the same,
394 so the implementation of this macro is very simple.
396 @param FunctionPointer A pointer to a function.
398 @return The pointer to the first instruction of a function given a function pointer.
401 #define FUNCTION_ENTRY_POINT(FunctionPointer) (VOID *)(UINTN)(FunctionPointer)