Move to directory "Include"
[mirror_edk2.git] / MdePkg / Include / x64 / ProcessorBind.h
CommitLineData
959ccb23 1/** @file\r
2 Processor or Compiler specific defines and types x64 (Intel(r) EM64T, AMD64).\r
3\r
4 Copyright (c) 2006, Intel Corporation \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 Module Name: ProcessorBind.h\r
14\r
15**/\r
16\r
17#ifndef __PROCESSOR_BIND_H__\r
18#define __PROCESSOR_BIND_H__\r
19\r
20//\r
21// Define the processor type so other code can make processor based choices\r
22//\r
23#define MDE_CPU_X64\r
24\r
25\r
26//\r
27// Make sure we are useing the correct packing rules per EFI specification\r
28//\r
29#ifndef __GNUC__\r
30#pragma pack()\r
31#endif\r
32\r
33#if _MSC_EXTENSIONS \r
34 \r
35//\r
36// Disable warning that make it impossible to compile at /W4\r
37// This only works for Microsoft* tools\r
38//\r
39\r
40//\r
41// Disabling bitfield type checking warnings.\r
42//\r
43#pragma warning ( disable : 4214 )\r
44\r
45//\r
46// Disabling the unreferenced formal parameter warnings.\r
47//\r
48#pragma warning ( disable : 4100 )\r
49\r
50//\r
51// Disable slightly different base types warning as CHAR8 * can not be set\r
52// to a constant string.\r
53//\r
54#pragma warning ( disable : 4057 )\r
55\r
56//\r
57// ASSERT(FALSE) or while (TRUE) are legal constructes so supress this warning\r
58//\r
59#pragma warning ( disable : 4127 )\r
60\r
61//\r
62// This warning is caused by functions defined but not used. For precompiled header only.\r
63//\r
64#pragma warning ( disable : 4505 )\r
65\r
66//\r
67// This warning is caused by empty (after preprocessing) souce file. For precompiled header only.\r
68//\r
69#pragma warning ( disable : 4206 )\r
70\r
71#endif\r
72\r
73\r
74#if !defined(__GNUC__) && (__STDC_VERSION__ < 199901L)\r
75 //\r
76 // No ANSI C 2000 stdint.h integer width declarations, so define equivalents\r
77 //\r
78 \r
79 #if _MSC_EXTENSIONS \r
80 \r
81\r
82 //\r
83 // use Microsoft C complier dependent interger width types \r
84 //\r
85 typedef unsigned __int64 UINT64;\r
86 typedef __int64 INT64;\r
87 typedef unsigned __int32 UINT32;\r
88 typedef __int32 INT32;\r
89 typedef unsigned short UINT16;\r
90 typedef unsigned short CHAR16;\r
91 typedef short INT16;\r
92 typedef unsigned char BOOLEAN;\r
93 typedef unsigned char UINT8;\r
94 typedef char CHAR8;\r
95 typedef char INT8;\r
96 #else\r
97 #ifdef _EFI_P64 \r
98 //\r
99 // P64 - is Intel Itanium(TM) speak for pointers being 64-bit and longs and ints \r
100 // are 32-bits\r
101 //\r
102 typedef unsigned long long UINT64;\r
103 typedef long long INT64;\r
104 typedef unsigned int UINT32;\r
105 typedef int INT32;\r
106 typedef unsigned short CHAR16;\r
107 typedef unsigned short UINT16;\r
108 typedef short INT16;\r
109 typedef unsigned char BOOLEAN;\r
110 typedef unsigned char UINT8;\r
111 typedef char CHAR8;\r
112 typedef char INT8;\r
113 #else\r
114 //\r
115 // Assume LP64 - longs and pointers are 64-bit. Ints are 32-bit.\r
116 //\r
117 typedef unsigned long UINT64;\r
118 typedef long INT64;\r
119 typedef unsigned int UINT32;\r
120 typedef int INT32;\r
121 typedef unsigned short UINT16;\r
122 typedef unsigned short CHAR16;\r
123 typedef short INT16;\r
124 typedef unsigned char BOOLEAN;\r
125 typedef unsigned char UINT8;\r
126 typedef char CHAR8;\r
127 typedef char INT8;\r
128 #endif\r
129 #endif\r
130\r
131 #define UINT8_MAX 0xff\r
132\r
133#else\r
134 //\r
135 // Use ANSI C 2000 stdint.h integer width declarations\r
136 //\r
137 #include <stdint.h>\r
138 typedef uint8_t BOOLEAN;\r
139 typedef int8_t INT8;\r
140 typedef uint8_t UINT8;\r
141 typedef int16_t INT16;\r
142 typedef uint16_t UINT16;\r
143 typedef int32_t INT32;\r
144 typedef uint32_t UINT32;\r
145 typedef int64_t INT64;\r
146 typedef uint64_t UINT64;\r
147 typedef char CHAR8;\r
148 typedef uint16_t CHAR16;\r
149\r
150#endif\r
151\r
152typedef UINT64 UINTN;\r
153typedef INT64 INTN;\r
154\r
155\r
156//\r
157// Processor specific defines\r
158//\r
159#define MAX_BIT 0x8000000000000000ULL\r
160#define MAX_2_BITS 0xC000000000000000ULL\r
161\r
162//\r
163// Maximum legal X64 address\r
164//\r
165#define MAX_ADDRESS 0xFFFFFFFFFFFFFFFFULL\r
166\r
167//\r
168// The stack alignment required for X64\r
169//\r
170#define CPU_STACK_ALIGNMENT 16\r
171\r
172//\r
173// Modifier to ensure that all protocol member functions and EFI intrinsics\r
174// use the correct C calling convention. All protocol member functions and\r
175// EFI intrinsics are required to modify thier member functions with EFIAPI.\r
176//\r
177#if _MSC_EXTENSIONS \r
178 ///\r
179 /// Define the standard calling convention reguardless of optimization level.\r
180 /// __cdecl is Microsoft* specific C extension.\r
181 /// \r
182 #define EFIAPI __cdecl \r
183#elif __GNUC__\r
184 ///\r
185 /// Define the standard calling convention reguardless of optimization level.\r
186 /// The GCC support assumes a GCC compiler that supports the EFI ABI. The EFI\r
187 /// ABI is much closer to the x64 Microsoft* ABI than standard x64 (x86-64) \r
188 /// GCC ABI. Thus a standard x64 (x86-64) GCC compiler can not be used for \r
189 /// x64. Warning the assembly code in the MDE x64 does not follow the correct \r
190 /// ABI for the standard x64 (x86-64) GCC.\r
191 ///\r
192 #define EFIAPI \r
193#else\r
194 ///\r
195 /// The default for a non Microsoft* or GCC compiler is to assume the EFI ABI\r
196 /// is the standard. \r
197 ///\r
198 #define EFIAPI \r
199#endif\r
200\r
201//\r
202// The Microsoft* C compiler can removed references to unreferenced data items\r
203// if the /OPT:REF linker option is used. We defined a macro as this is a \r
204// a non standard extension\r
205//\r
206#if _MSC_EXTENSIONS\r
207 #define GLOBAL_REMOVE_IF_UNREFERENCED __declspec(selectany)\r
208#else\r
209 #define GLOBAL_REMOVE_IF_UNREFERENCED\r
210#endif\r
211\r
212#endif\r
213\r