]>
git.proxmox.com Git - mirror_edk2.git/blob - MdePkg/Include/X64/ProcessorBind.h
2 Processor or Compiler specific defines and types x64 (Intel 64, AMD64).
4 Copyright (c) 2006 - 2015, 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 // Disable these warnings for VS2013.
104 // This warning is for potentially uninitialized local variable, and it may cause false
105 // positive issues in VS2013 build
107 #pragma warning ( disable : 4701 )
110 // This warning is for potentially uninitialized local pointer variable, and it may cause
111 // false positive issues in VS2013 build
113 #pragma warning ( disable : 4703 )
120 #if defined(_MSC_EXTENSIONS)
122 // use Microsoft C complier dependent integer width types
126 /// 8-byte unsigned value
128 typedef unsigned __int64 UINT64
;
130 /// 8-byte signed value
132 typedef __int64 INT64
;
134 /// 4-byte unsigned value
136 typedef unsigned __int32 UINT32
;
138 /// 4-byte signed value
140 typedef __int32 INT32
;
142 /// 2-byte unsigned value
144 typedef unsigned short UINT16
;
146 /// 2-byte Character. Unless otherwise specified all strings are stored in the
147 /// UTF-16 encoding format as defined by Unicode 2.1 and ISO/IEC 10646 standards.
149 typedef unsigned short CHAR16
;
151 /// 2-byte signed value
155 /// Logical Boolean. 1-byte value containing 0 for FALSE or a 1 for TRUE. Other
156 /// values are undefined.
158 typedef unsigned char BOOLEAN
;
160 /// 1-byte unsigned value
162 typedef unsigned char UINT8
;
168 /// 1-byte signed value
170 typedef signed char INT8
;
173 /// 8-byte unsigned value
175 typedef unsigned long long UINT64
;
177 /// 8-byte signed value
179 typedef long long INT64
;
181 /// 4-byte unsigned value
183 typedef unsigned int UINT32
;
185 /// 4-byte signed value
189 /// 2-byte unsigned value
191 typedef unsigned short UINT16
;
193 /// 2-byte Character. Unless otherwise specified all strings are stored in the
194 /// UTF-16 encoding format as defined by Unicode 2.1 and ISO/IEC 10646 standards.
196 typedef unsigned short CHAR16
;
198 /// 2-byte signed value
202 /// Logical Boolean. 1-byte value containing 0 for FALSE or a 1 for TRUE. Other
203 /// values are undefined.
205 typedef unsigned char BOOLEAN
;
207 /// 1-byte unsigned value
209 typedef unsigned char UINT8
;
215 /// 1-byte signed value
217 typedef signed char INT8
;
221 /// Unsigned value of native width. (4 bytes on supported 32-bit processor instructions,
222 /// 8 bytes on supported 64-bit processor instructions)
224 typedef UINT64 UINTN
;
226 /// Signed value of native width. (4 bytes on supported 32-bit processor instructions,
227 /// 8 bytes on supported 64-bit processor instructions)
233 // Processor specific defines
237 /// A value of native width with the highest bit set.
239 #define MAX_BIT 0x8000000000000000ULL
241 /// A value of native width with the two highest bits set.
243 #define MAX_2_BITS 0xC000000000000000ULL
246 /// Maximum legal x64 address
248 #define MAX_ADDRESS 0xFFFFFFFFFFFFFFFFULL
251 /// Maximum legal x64 INTN and UINTN values.
253 #define MAX_INTN ((INTN)0x7FFFFFFFFFFFFFFFULL)
254 #define MAX_UINTN ((UINTN)0xFFFFFFFFFFFFFFFFULL)
257 /// The stack alignment required for x64
259 #define CPU_STACK_ALIGNMENT 16
262 // Modifier to ensure that all protocol member functions and EFI intrinsics
263 // use the correct C calling convention. All protocol member functions and
264 // EFI intrinsics are required to modify their member functions with EFIAPI.
268 /// If EFIAPI is already defined, then we use that definition.
270 #elif defined(_MSC_EXTENSIONS)
272 /// Microsoft* compiler specific method for EFIAPI calling convention.
274 #define EFIAPI __cdecl
275 #elif defined(__GNUC__)
277 /// Define the standard calling convention regardless of optimization level.
278 /// The GCC support assumes a GCC compiler that supports the EFI ABI. The EFI
279 /// ABI is much closer to the x64 Microsoft* ABI than standard x64 (x86-64)
280 /// GCC ABI. Thus a standard x64 (x86-64) GCC compiler can not be used for
281 /// x64. Warning the assembly code in the MDE x64 does not follow the correct
282 /// ABI for the standard x64 (x86-64) GCC.
287 /// The default for a non Microsoft* or GCC compiler is to assume the EFI ABI
293 #if defined(__GNUC__)
295 /// For GNU assembly code, .global or .globl can declare global symbols.
296 /// Define this macro to unify the usage.
298 #define ASM_GLOBAL .globl
302 Return the pointer to the first instruction of a function given a function pointer.
303 On x64 CPU architectures, these two pointer values are the same,
304 so the implementation of this macro is very simple.
306 @param FunctionPointer A pointer to a function.
308 @return The pointer to the first instruction of a function given a function pointer.
311 #define FUNCTION_ENTRY_POINT(FunctionPointer) (VOID *)(UINTN)(FunctionPointer)
313 #ifndef __USER_LABEL_PREFIX__
314 #define __USER_LABEL_PREFIX__