2 Processor or Compiler specific defines and types x64 (Intel 64, AMD64).
4 Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.<BR>
5 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(_MSC_EXTENSIONS)
102 // use Microsoft C complier dependent integer width types
106 /// 8-byte unsigned value
108 typedef unsigned __int64 UINT64
;
110 /// 8-byte signed value
112 typedef __int64 INT64
;
114 /// 4-byte unsigned value
116 typedef unsigned __int32 UINT32
;
118 /// 4-byte signed value
120 typedef __int32 INT32
;
122 /// 2-byte unsigned value
124 typedef unsigned short UINT16
;
126 /// 2-byte Character. Unless otherwise specified all strings are stored in the
127 /// UTF-16 encoding format as defined by Unicode 2.1 and ISO/IEC 10646 standards.
129 typedef unsigned short CHAR16
;
131 /// 2-byte signed value
135 /// Logical Boolean. 1-byte value containing 0 for FALSE or a 1 for TRUE. Other
136 /// values are undefined.
138 typedef unsigned char BOOLEAN
;
140 /// 1-byte unsigned value
142 typedef unsigned char UINT8
;
148 /// 1-byte signed value
150 typedef signed char INT8
;
153 /// 8-byte unsigned value
155 typedef unsigned long long UINT64
;
157 /// 8-byte signed value
159 typedef long long INT64
;
161 /// 4-byte unsigned value
163 typedef unsigned int UINT32
;
165 /// 4-byte signed value
169 /// 2-byte unsigned value
171 typedef unsigned short UINT16
;
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 signed value
182 /// Logical Boolean. 1-byte value containing 0 for FALSE or a 1 for TRUE. Other
183 /// values are undefined.
185 typedef unsigned char BOOLEAN
;
187 /// 1-byte unsigned value
189 typedef unsigned char UINT8
;
195 /// 1-byte signed value
197 typedef signed char INT8
;
201 /// Unsigned value of native width. (4 bytes on supported 32-bit processor instructions,
202 /// 8 bytes on supported 64-bit processor instructions)
204 typedef UINT64 UINTN
;
206 /// Signed value of native width. (4 bytes on supported 32-bit processor instructions,
207 /// 8 bytes on supported 64-bit processor instructions)
213 // Processor specific defines
217 /// A value of native width with the highest bit set.
219 #define MAX_BIT 0x8000000000000000ULL
221 /// A value of native width with the two highest bits set.
223 #define MAX_2_BITS 0xC000000000000000ULL
226 /// Maximum legal x64 address
228 #define MAX_ADDRESS 0xFFFFFFFFFFFFFFFFULL
231 /// The stack alignment required for x64
233 #define CPU_STACK_ALIGNMENT 16
236 // Modifier to ensure that all protocol member functions and EFI intrinsics
237 // use the correct C calling convention. All protocol member functions and
238 // EFI intrinsics are required to modify their member functions with EFIAPI.
242 /// If EFIAPI is already defined, then we use that definition.
244 #elif defined(_MSC_EXTENSIONS)
246 /// Microsoft* compiler specific method for EFIAPI calling convension
248 #define EFIAPI __cdecl
249 #elif defined(__GNUC__)
251 /// Define the standard calling convention reguardless of optimization level.
252 /// The GCC support assumes a GCC compiler that supports the EFI ABI. The EFI
253 /// ABI is much closer to the x64 Microsoft* ABI than standard x64 (x86-64)
254 /// GCC ABI. Thus a standard x64 (x86-64) GCC compiler can not be used for
255 /// x64. Warning the assembly code in the MDE x64 does not follow the correct
256 /// ABI for the standard x64 (x86-64) GCC.
261 /// The default for a non Microsoft* or GCC compiler is to assume the EFI ABI
267 #if defined(__GNUC__)
269 /// For GNU assembly code, .global or .globl can declare global symbols.
270 /// Define this macro to unify the usage.
272 #define ASM_GLOBAL .globl
276 Return the pointer to the first instruction of a function given a function pointer.
277 On x64 CPU architectures, these two pointer values are the same,
278 so the implementation of this macro is very simple.
280 @param FunctionPointer A pointer to a function.
282 @return The pointer to the first instruction of a function given a function pointer.
285 #define FUNCTION_ENTRY_POINT(FunctionPointer) (VOID *)(UINTN)(FunctionPointer)