]> git.proxmox.com Git - mirror_edk2.git/blame_incremental - MdePkg/Include/X64/ProcessorBind.h
projects / mirror_edk2.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
retire gEfiFirmwareVolumeDispatcherProtocolGuid
[mirror_edk2.git] / MdePkg / Include / X64 / ProcessorBind.h
... / ...
CommitLineData
1/** @file\r
2 Processor or Compiler specific defines and types x64 (Intel(r) EM64T, AMD64).\r
3\r
4 Copyright (c) 2006 - 2008, Intel Corporation<BR> \r
5 All rights reserved. This program and the accompanying materials \r
6 are licensed and made available under the terms and conditions of the BSD License \r
7 which accompanies this distribution. The full text of the license may be found at \r
8 http://opensource.org/licenses/bsd-license.php \r
9\r
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
12\r
13**/\r
14\r
15#ifndef __PROCESSOR_BIND_H__\r
16#define __PROCESSOR_BIND_H__\r
17\r
18///\r
19/// Define the processor type so other code can make processor based choices\r
20///\r
21#define MDE_CPU_X64\r
22\r
23\r
24//\r
25// Make sure we are using the correct packing rules per EFI specification\r
26//\r
27#ifndef __GNUC__\r
28#pragma pack()\r
29#endif\r
30\r
31\r
32#if __INTEL_COMPILER\r
33//\r
34// Disable ICC's remark #869: "Parameter" was never referenced warning.\r
35// This is legal ANSI C code so we disable the remark that is turned on with -Wall\r
36//\r
37#pragma warning ( disable : 869 )\r
38\r
39//\r
40// Disable ICC's remark #1418: external function definition with no prior declaration.\r
41// This is legal ANSI C code so we disable the remark that is turned on with /W4\r
42//\r
43#pragma warning ( disable : 1418 )\r
44\r
45//\r
46// Disable ICC's remark #1419: external declaration in primary source file\r
47// This is legal ANSI C code so we disable the remark that is turned on with /W4\r
48//\r
49#pragma warning ( disable : 1419 )\r
50\r
51#endif\r
52\r
53\r
54#if _MSC_EXTENSIONS\r
55\r
56//\r
57// Disable warning that make it impossible to compile at /W4\r
58// This only works for Microsoft* tools\r
59//\r
60\r
61//\r
62// Disabling bitfield type checking warnings.\r
63//\r
64#pragma warning ( disable : 4214 )\r
65\r
66//\r
67// Disabling the unreferenced formal parameter warnings.\r
68//\r
69#pragma warning ( disable : 4100 )\r
70\r
71//\r
72// Disable slightly different base types warning as CHAR8 * can not be set\r
73// to a constant string.\r
74//\r
75#pragma warning ( disable : 4057 )\r
76\r
77//\r
78// ASSERT(FALSE) or while (TRUE) are legal constructes so supress this warning\r
79//\r
80#pragma warning ( disable : 4127 )\r
81\r
82//\r
83// This warning is caused by functions defined but not used. For precompiled header only.\r
84//\r
85#pragma warning ( disable : 4505 )\r
86\r
87//\r
88// This warning is caused by empty (after preprocessing) source file. For precompiled header only.\r
89//\r
90#pragma warning ( disable : 4206 )\r
91\r
92#endif\r
93\r
94\r
95#if !defined(__GNUC__) && (__STDC_VERSION__ < 199901L)\r
96 //\r
97 // No ANSI C 2000 stdint.h integer width declarations, so define equivalents\r
98 //\r
99 \r
100 #if _MSC_EXTENSIONS \r
101 //\r
102 // use Microsoft C complier dependent integer width types \r
103 //\r
104\r
105 ///\r
106 /// 8-byte unsigned value\r
107 ///\r
108 typedef unsigned __int64 UINT64;\r
109 ///\r
110 /// 8-byte signed value\r
111 ///\r
112 typedef __int64 INT64;\r
113 ///\r
114 /// 4-byte unsigned value\r
115 ///\r
116 typedef unsigned __int32 UINT32;\r
117 ///\r
118 /// 4-byte signed value\r
119 ///\r
120 typedef __int32 INT32;\r
121 ///\r
122 /// 2-byte unsigned value\r
123 ///\r
124 typedef unsigned short UINT16;\r
125 ///\r
126 /// 2-byte Character. Unless otherwise specified all strings are stored in the\r
127 /// UTF-16 encoding format as defined by Unicode 2.1 and ISO/IEC 10646 standards.\r
128 ///\r
129 typedef unsigned short CHAR16;\r
130 ///\r
131 /// 2-byte signed value\r
132 ///\r
133 typedef short INT16;\r
134 ///\r
135 /// Logical Boolean. 1-byte value containing 0 for FALSE or a 1 for TRUE. Other\r
136 /// values are undefined.\r
137 ///\r
138 typedef unsigned char BOOLEAN;\r
139 ///\r
140 /// 1-byte unsigned value\r
141 ///\r
142 typedef unsigned char UINT8;\r
143 ///\r
144 /// 1-byte Character\r
145 ///\r
146 typedef char CHAR8;\r
147 ///\r
148 /// 1-byte signed value\r
149 ///\r
150 typedef char INT8;\r
151 #else\r
152 #ifdef _EFI_P64 \r
153 //\r
154 // P64 - pointers being 64-bit and longs and ints are 32-bits.\r
155 //\r
156\r
157 ///\r
158 /// 8-byte unsigned value\r
159 ///\r
160 typedef unsigned long long UINT64;\r
161 ///\r
162 /// 8-byte signed value\r
163 ///\r
164 typedef long long INT64;\r
165 ///\r
166 /// 4-byte unsigned value\r
167 ///\r
168 typedef unsigned int UINT32;\r
169 ///\r
170 /// 4-byte signed value\r
171 ///\r
172 typedef int INT32;\r
173 ///\r
174 /// 2-byte Character. Unless otherwise specified all strings are stored in the\r
175 /// UTF-16 encoding format as defined by Unicode 2.1 and ISO/IEC 10646 standards.\r
176 ///\r
177 typedef unsigned short CHAR16;\r
178 ///\r
179 /// 2-byte unsigned value\r
180 ///\r
181 typedef unsigned short UINT16;\r
182 ///\r
183 /// 2-byte signed value\r
184 ///\r
185 typedef short INT16;\r
186 ///\r
187 /// Logical Boolean. 1-byte value containing 0 for FALSE or a 1 for TRUE. Other\r
188 /// values are undefined.\r
189 ///\r
190 typedef unsigned char BOOLEAN;\r
191 ///\r
192 /// 1-byte unsigned value\r
193 ///\r
194 typedef unsigned char UINT8;\r
195 ///\r
196 /// 1-byte Character\r
197 ///\r
198 typedef char CHAR8;\r
199 ///\r
200 /// 1-byte signed value\r
201 ///\r
202 typedef char INT8;\r
203 #else\r
204 //\r
205 // Assume LP64 - longs and pointers are 64-bit. Ints are 32-bit.\r
206 //\r
207\r
208 ///\r
209 /// 8-byte unsigned value\r
210 ///\r
211 typedef unsigned long UINT64;\r
212 ///\r
213 /// 8-byte signed value\r
214 ///\r
215 typedef long INT64;\r
216 ///\r
217 /// 4-byte unsigned value\r
218 ///\r
219 typedef unsigned int UINT32;\r
220 ///\r
221 /// 4-byte signed value\r
222 ///\r
223 typedef int INT32;\r
224 ///\r
225 /// 2-byte unsigned value\r
226 ///\r
227 typedef unsigned short UINT16;\r
228 ///\r
229 /// 2-byte Character. Unless otherwise specified all strings are stored in the\r
230 /// UTF-16 encoding format as defined by Unicode 2.1 and ISO/IEC 10646 standards.\r
231 ///\r
232 typedef unsigned short CHAR16;\r
233 ///\r
234 /// 2-byte signed value\r
235 ///\r
236 typedef short INT16;\r
237 ///\r
238 /// Logical Boolean. 1-byte value containing 0 for FALSE or a 1 for TRUE. Other\r
239 /// values are undefined.\r
240 ///\r
241 typedef unsigned char BOOLEAN;\r
242 ///\r
243 /// 1-byte unsigned value\r
244 ///\r
245 typedef unsigned char UINT8;\r
246 ///\r
247 /// 1-byte Character\r
248 ///\r
249 typedef char CHAR8;\r
250 ///\r
251 /// 1-byte signed value\r
252 ///\r
253 typedef char INT8;\r
254 #endif\r
255 #endif\r
256#else\r
257 //\r
258 // Use ANSI C 2000 stdint.h integer width declarations\r
259 //\r
260 #include <stdint.h>\r
261\r
262 ///\r
263 /// Logical Boolean. 1-byte value containing 0 for FALSE or a 1 for TRUE. Other\r
264 /// values are undefined.\r
265 ///\r
266 typedef uint8_t BOOLEAN;\r
267 ///\r
268 /// 1-byte signed value\r
269 ///\r
270 typedef int8_t INT8;\r
271 ///\r
272 /// 1-byte unsigned value\r
273 ///\r
274 typedef uint8_t UINT8;\r
275 ///\r
276 /// 2-byte signed value\r
277 ///\r
278 typedef int16_t INT16;\r
279 ///\r
280 /// 2-byte unsigned value\r
281 ///\r
282 typedef uint16_t UINT16;\r
283 ///\r
284 /// 4-byte signed value\r
285 ///\r
286 typedef int32_t INT32;\r
287 ///\r
288 /// 4-byte unsigned value\r
289 ///\r
290 typedef uint32_t UINT32;\r
291 ///\r
292 /// 8-byte signed value\r
293 ///\r
294 typedef int64_t INT64;\r
295 ///\r
296 /// 8-byte unsigned value\r
297 ///\r
298 typedef uint64_t UINT64;\r
299 ///\r
300 /// 1-byte Character\r
301 ///\r
302 typedef char CHAR8;\r
303 ///\r
304 /// 2-byte Character. Unless otherwise specified all strings are stored in the\r
305 /// UTF-16 encoding format as defined by Unicode 2.1 and ISO/IEC 10646 standards.\r
306 ///\r
307 typedef uint16_t CHAR16;\r
308\r
309#endif\r
310\r
311///\r
312/// Unsigned value of native width. (4 bytes on supported 32-bit processor instructions,\r
313/// 8 bytes on supported 64-bit processor instructions)\r
314///\r
315typedef UINT64 UINTN;\r
316///\r
317/// Signed value of native width. (4 bytes on supported 32-bit processor instructions,\r
318/// 8 bytes on supported 64-bit processor instructions)\r
319///\r
320typedef INT64 INTN;\r
321\r
322\r
323//\r
324// Processor specific defines\r
325//\r
326\r
327///\r
328/// A value of native width with the highest bit set.\r
329///\r
330#define MAX_BIT 0x8000000000000000ULL\r
331///\r
332/// A value of native width with the two highest bits set.\r
333///\r
334#define MAX_2_BITS 0xC000000000000000ULL\r
335\r
336///\r
337/// Maximum legal x64 address\r
338///\r
339#define MAX_ADDRESS 0xFFFFFFFFFFFFFFFFULL\r
340\r
341///\r
342/// The stack alignment required for x64\r
343///\r
344#define CPU_STACK_ALIGNMENT 16\r
345\r
346//\r
347// Modifier to ensure that all protocol member functions and EFI intrinsics\r
348// use the correct C calling convention. All protocol member functions and\r
349// EFI intrinsics are required to modify their member functions with EFIAPI.\r
350//\r
351#if _MSC_EXTENSIONS \r
352 ///\r
353 /// Microsoft* compiler specific method for EFIAPI calling convension\r
354 /// \r
355 #define EFIAPI __cdecl \r
356#elif __GNUC__\r
357 ///\r
358 /// Define the standard calling convention reguardless of optimization level.\r
359 /// The GCC support assumes a GCC compiler that supports the EFI ABI. The EFI\r
360 /// ABI is much closer to the x64 Microsoft* ABI than standard x64 (x86-64) \r
361 /// GCC ABI. Thus a standard x64 (x86-64) GCC compiler can not be used for \r
362 /// x64. Warning the assembly code in the MDE x64 does not follow the correct \r
363 /// ABI for the standard x64 (x86-64) GCC.\r
364 ///\r
365 #define EFIAPI \r
366#else\r
367 ///\r
368 /// The default for a non Microsoft* or GCC compiler is to assume the EFI ABI\r
369 /// is the standard. \r
370 ///\r
371 #define EFIAPI \r
372#endif\r
373\r
374//\r
375// The Microsoft* C compiler can removed references to unreferenced data items\r
376// if the /OPT:REF linker option is used. We defined a macro as this is a \r
377// a non standard extension\r
378//\r
379#if _MSC_EXTENSIONS\r
380 ///\r
381 /// Remove global variable from the linked image if there are no references to \r
382 /// it after all compiler and linker optimizations have been performed.\r
383 ///\r
384 ///\r
385 #define GLOBAL_REMOVE_IF_UNREFERENCED __declspec(selectany)\r
386#else\r
387 ///\r
388 /// Remove global variable from the linked image if there are no references to \r
389 /// it after all compiler and linker optimizations have been performed.\r
390 ///\r
391 ///\r
392 #define GLOBAL_REMOVE_IF_UNREFERENCED\r
393#endif\r
394\r
395//\r
396// For symbol name in GNU assembly code, an extra "_" is necessary\r
397//\r
398#if __GNUC__\r
399 #if defined(linux)\r
400 #define ASM_PFX(name) name\r
401 #else\r
402 #define ASM_PFX(name) _##name\r
403 #endif \r
404#endif\r
405\r
406/**\r
407 Return the pointer to the first instruction of a function given a function pointer.\r
408 On x64 CPU architectures, these two pointer values are the same, \r
409 so the implementation of this macro is very simple.\r
410 \r
411 @param FunctionPointer A pointer to a function.\r
412\r
413 @return The pointer to the first instruction of a function given a function pointer.\r
414 \r
415**/\r
416#define FUNCTION_ENTRY_POINT(FunctionPointer) (VOID *)(UINTN)(FunctionPointer)\r
417\r
418#endif\r
419\r
EFI Development Kit II mirror for PVE