]>
git.proxmox.com Git - mirror_edk2.git/blob - MdePkg/Include/X64/ProcessorBind.h
2 Processor or Compiler specific defines and types x64 (Intel(r) EM64T, 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
25 // Make sure we are using the correct packing rules per EFI specification
27 #if !defined(__GNUC__)
32 #if defined(__INTEL_COMPILER)
34 // Disable ICC's remark #869: "Parameter" was never referenced warning.
35 // This is legal ANSI C code so we disable the remark that is turned on with -Wall
37 #pragma warning ( disable : 869 )
40 // Disable ICC's remark #1418: external function definition with no prior declaration.
41 // This is legal ANSI C code so we disable the remark that is turned on with /W4
43 #pragma warning ( disable : 1418 )
46 // Disable ICC's remark #1419: external declaration in primary source file
47 // This is legal ANSI C code so we disable the remark that is turned on with /W4
49 #pragma warning ( disable : 1419 )
54 #if defined(_MSC_EXTENSIONS)
57 // Disable warning that make it impossible to compile at /W4
58 // This only works for Microsoft* tools
62 // Disabling bitfield type checking warnings.
64 #pragma warning ( disable : 4214 )
67 // Disabling the unreferenced formal parameter warnings.
69 #pragma warning ( disable : 4100 )
72 // Disable slightly different base types warning as CHAR8 * can not be set
73 // to a constant string.
75 #pragma warning ( disable : 4057 )
78 // ASSERT(FALSE) or while (TRUE) are legal constructes so supress this warning
80 #pragma warning ( disable : 4127 )
83 // This warning is caused by functions defined but not used. For precompiled header only.
85 #pragma warning ( disable : 4505 )
88 // This warning is caused by empty (after preprocessing) source file. For precompiled header only.
90 #pragma warning ( disable : 4206 )
95 #if !defined(__GNUC__) && (__STDC_VERSION__ < 199901L)
97 // No ANSI C 2000 stdint.h integer width declarations, so define equivalents
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
152 #if defined(_EFI_P64)
154 // P64 - pointers being 64-bit and longs and ints are 32-bits.
158 /// 8-byte unsigned value
160 typedef unsigned long long UINT64
;
162 /// 8-byte signed value
164 typedef long long INT64
;
166 /// 4-byte unsigned value
168 typedef unsigned int UINT32
;
170 /// 4-byte signed value
174 /// 2-byte Character. Unless otherwise specified all strings are stored in the
175 /// UTF-16 encoding format as defined by Unicode 2.1 and ISO/IEC 10646 standards.
177 typedef unsigned short CHAR16
;
179 /// 2-byte unsigned value
181 typedef unsigned short UINT16
;
183 /// 2-byte signed value
187 /// Logical Boolean. 1-byte value containing 0 for FALSE or a 1 for TRUE. Other
188 /// values are undefined.
190 typedef unsigned char BOOLEAN
;
192 /// 1-byte unsigned value
194 typedef unsigned char UINT8
;
200 /// 1-byte signed value
205 // Assume LP64 - longs and pointers are 64-bit. Ints are 32-bit.
209 /// 8-byte unsigned value
211 typedef unsigned long UINT64
;
213 /// 8-byte signed value
217 /// 4-byte unsigned value
219 typedef unsigned int UINT32
;
221 /// 4-byte signed value
225 /// 2-byte unsigned value
227 typedef unsigned short UINT16
;
229 /// 2-byte Character. Unless otherwise specified all strings are stored in the
230 /// UTF-16 encoding format as defined by Unicode 2.1 and ISO/IEC 10646 standards.
232 typedef unsigned short CHAR16
;
234 /// 2-byte signed value
238 /// Logical Boolean. 1-byte value containing 0 for FALSE or a 1 for TRUE. Other
239 /// values are undefined.
241 typedef unsigned char BOOLEAN
;
243 /// 1-byte unsigned value
245 typedef unsigned char UINT8
;
251 /// 1-byte signed value
258 // Use ANSI C 2000 stdint.h integer width declarations
263 /// Logical Boolean. 1-byte value containing 0 for FALSE or a 1 for TRUE. Other
264 /// values are undefined.
266 typedef uint8_t BOOLEAN
;
268 /// 1-byte signed value
272 /// 1-byte unsigned value
274 typedef uint8_t UINT8
;
276 /// 2-byte signed value
278 typedef int16_t INT16
;
280 /// 2-byte unsigned value
282 typedef uint16_t UINT16
;
284 /// 4-byte signed value
286 typedef int32_t INT32
;
288 /// 4-byte unsigned value
290 typedef uint32_t UINT32
;
292 /// 8-byte signed value
294 typedef int64_t INT64
;
296 /// 8-byte unsigned value
298 typedef uint64_t UINT64
;
304 /// 2-byte Character. Unless otherwise specified all strings are stored in the
305 /// UTF-16 encoding format as defined by Unicode 2.1 and ISO/IEC 10646 standards.
307 typedef uint16_t CHAR16
;
312 /// Unsigned value of native width. (4 bytes on supported 32-bit processor instructions,
313 /// 8 bytes on supported 64-bit processor instructions)
315 typedef UINT64 UINTN
;
317 /// Signed value of native width. (4 bytes on supported 32-bit processor instructions,
318 /// 8 bytes on supported 64-bit processor instructions)
324 // Processor specific defines
328 /// A value of native width with the highest bit set.
330 #define MAX_BIT 0x8000000000000000ULL
332 /// A value of native width with the two highest bits set.
334 #define MAX_2_BITS 0xC000000000000000ULL
337 /// Maximum legal x64 address
339 #define MAX_ADDRESS 0xFFFFFFFFFFFFFFFFULL
342 /// The stack alignment required for x64
344 #define CPU_STACK_ALIGNMENT 16
347 // Modifier to ensure that all protocol member functions and EFI intrinsics
348 // use the correct C calling convention. All protocol member functions and
349 // EFI intrinsics are required to modify their member functions with EFIAPI.
353 /// If EFIAPI is already defined, then we use that definition.
355 #elif defined(_MSC_EXTENSIONS)
357 /// Microsoft* compiler specific method for EFIAPI calling convension
359 #define EFIAPI __cdecl
360 #elif defined(__GNUC__)
362 /// Define the standard calling convention reguardless of optimization level.
363 /// The GCC support assumes a GCC compiler that supports the EFI ABI. The EFI
364 /// ABI is much closer to the x64 Microsoft* ABI than standard x64 (x86-64)
365 /// GCC ABI. Thus a standard x64 (x86-64) GCC compiler can not be used for
366 /// x64. Warning the assembly code in the MDE x64 does not follow the correct
367 /// ABI for the standard x64 (x86-64) GCC.
372 /// The default for a non Microsoft* or GCC compiler is to assume the EFI ABI
379 // The Microsoft* C compiler can removed references to unreferenced data items
380 // if the /OPT:REF linker option is used. We defined a macro as this is a
381 // a non standard extension
383 #if defined(_MSC_EXTENSIONS)
385 /// Remove global variable from the linked image if there are no references to
386 /// it after all compiler and linker optimizations have been performed.
389 #define GLOBAL_REMOVE_IF_UNREFERENCED __declspec(selectany)
392 /// Remove global variable from the linked image if there are no references to
393 /// it after all compiler and linker optimizations have been performed.
396 #define GLOBAL_REMOVE_IF_UNREFERENCED
400 // For symbol name in GNU assembly code, an extra "_" is necessary
402 #if defined(__GNUC__)
404 #define ASM_PFX(name) name
406 #define ASM_PFX(name) _##name
411 Return the pointer to the first instruction of a function given a function pointer.
412 On x64 CPU architectures, these two pointer values are the same,
413 so the implementation of this macro is very simple.
415 @param FunctionPointer A pointer to a function.
417 @return The pointer to the first instruction of a function given a function pointer.
420 #define FUNCTION_ENTRY_POINT(FunctionPointer) (VOID *)(UINTN)(FunctionPointer)