]>
git.proxmox.com Git - mirror_edk2.git/blob - MdePkg/Include/Ia32/ProcessorBind.h
2 Processor or Compiler specific defines and types for Ia32 architecture.
4 Copyright (c) 2006 - 2008, 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__)
30 #if defined(__INTEL_COMPILER)
32 // Disable ICC's remark #869: "Parameter" was never referenced warning.
33 // This is legal ANSI C code so we disable the remark that is turned on with -Wall
35 #pragma warning ( disable : 869 )
38 // Disable ICC's remark #1418: external function definition with no prior declaration.
39 // This is legal ANSI C code so we disable the remark that is turned on with /W4
41 #pragma warning ( disable : 1418 )
44 // Disable ICC's remark #1419: external declaration in primary source file
45 // This is legal ANSI C code so we disable the remark that is turned on with /W4
47 #pragma warning ( disable : 1419 )
52 #if defined(_MSC_EXTENSIONS)
55 // Disable warning that make it impossible to compile at /W4
56 // This only works for Microsoft* tools
60 // Disabling bitfield type checking warnings.
62 #pragma warning ( disable : 4214 )
65 // Disabling the unreferenced formal parameter warnings.
67 #pragma warning ( disable : 4100 )
70 // Disable slightly different base types warning as CHAR8 * can not be set
71 // to a constant string.
73 #pragma warning ( disable : 4057 )
76 // ASSERT(FALSE) or while (TRUE) are legal constructes so supress this warning
78 #pragma warning ( disable : 4127 )
81 // This warning is caused by functions defined but not used. For precompiled header only.
83 #pragma warning ( disable : 4505 )
86 // This warning is caused by empty (after preprocessing) source file. For precompiled header only.
88 #pragma warning ( disable : 4206 )
93 #if !defined(__GNUC__) && (__STDC_VERSION__ < 199901L)
95 // No ANSI C 2000 stdint.h integer width declarations, so define equivalents
98 #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
153 // Assume standard IA-32 alignment.
154 // Need to check portability of long long
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 unsigned value
176 typedef unsigned short UINT16
;
178 /// 2-byte Character. Unless otherwise specified all strings are stored in the
179 /// UTF-16 encoding format as defined by Unicode 2.1 and ISO/IEC 10646 standards.
181 typedef unsigned short CHAR16
;
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
206 // Use ANSI C 2000 stdint.h integer width declarations
211 /// Logical Boolean. 1-byte value containing 0 for FALSE or a 1 for TRUE. Other
212 /// values are undefined.
214 typedef uint8_t BOOLEAN
;
216 /// 1-byte signed value
220 /// 1-byte unsigned value
222 typedef uint8_t UINT8
;
224 /// 2-byte signed value
226 typedef int16_t INT16
;
228 /// 2-byte unsigned value
230 typedef uint16_t UINT16
;
232 /// 4-byte signed value
234 typedef int32_t INT32
;
236 /// 4-byte unsigned value
238 typedef uint32_t UINT32
;
240 /// 8-byte signed value
242 typedef int64_t INT64
;
244 /// 8-byte unsigned value
246 typedef uint64_t UINT64
;
252 /// 2-byte Character. Unless otherwise specified all strings are stored in the
253 /// UTF-16 encoding format as defined by Unicode 2.1 and ISO/IEC 10646 standards.
255 typedef uint16_t CHAR16
;
260 /// Unsigned value of native width. (4 bytes on supported 32-bit processor instructions,
261 /// 8 bytes on supported 64-bit processor instructions)
263 typedef UINT32 UINTN
;
265 /// Signed value of native width. (4 bytes on supported 32-bit processor instructions,
266 /// 8 bytes on supported 64-bit processor instructions)
271 // Processor specific defines
275 /// A value of native width with the highest bit set.
277 #define MAX_BIT 0x80000000
279 /// A value of native width with the two highest bits set.
281 #define MAX_2_BITS 0xC0000000
284 /// Maximum legal IA-32 address
286 #define MAX_ADDRESS 0xFFFFFFFF
289 /// The stack alignment required for IA-32
291 #define CPU_STACK_ALIGNMENT sizeof(UINTN)
294 // Modifier to ensure that all protocol member functions and EFI intrinsics
295 // use the correct C calling convention. All protocol member functions and
296 // EFI intrinsics are required to modify their member functions with EFIAPI.
298 #if defined(_MSC_EXTENSIONS)
300 /// Microsoft* compiler specific method for EFIAPI calling convension
302 #define EFIAPI __cdecl
304 #if defined(__GNUC__)
306 /// GCC specific method for EFIAPI calling convension
308 #define EFIAPI __attribute__((cdecl))
313 // The Microsoft* C compiler can removed references to unreferenced data items
314 // if the /OPT:REF linker option is used. We defined a macro as this is a
315 // a non standard extension
317 #if defined(_MSC_EXTENSIONS)
319 /// Remove global variable from the linked image if there are no references to
320 /// it after all compiler and linker optimizations have been performed.
322 #define GLOBAL_REMOVE_IF_UNREFERENCED __declspec(selectany)
325 /// Remove global variable from the linked image if there are no references to
326 /// it after all compiler and linker optimizations have been performed.
328 #define GLOBAL_REMOVE_IF_UNREFERENCED
332 // For symbol name in GNU assembly code, an extra "_" is necessary
334 #if defined(__GNUC__)
336 #define ASM_PFX(name) name
338 #define ASM_PFX(name) _##name
343 Return the pointer to the first instruction of a function given a function pointer.
344 On IA32 CPU architectures, these two pointer values are the same,
345 so the implementation of this macro is very simple.
347 @param FunctionPointer A pointer to a function.
349 @return The pointer to the first instruction of a function given a function pointer.
352 #define FUNCTION_ENTRY_POINT(FunctionPointer) (VOID *)(UINTN)(FunctionPointer)