MdePkg/ProcessorBind: add defines for page allocation granularity
[mirror_edk2.git] / MdePkg / Include / Ia32 / ProcessorBind.h
CommitLineData
959ccb23 1/** @file\r
1a2f870c 2 Processor or Compiler specific defines and types for IA-32 architecture.\r
959ccb23 3\r
a5077fd0 4Copyright (c) 2006 - 2015, Intel Corporation. All rights reserved.<BR>\r
8c18db27 5This program and the accompanying materials are licensed and made available under \r
6the terms and conditions of the BSD License that accompanies this distribution. \r
7The full text of the license may be found at\r
8http://opensource.org/licenses/bsd-license.php. \r
9 \r
10THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
11WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
959ccb23 12\r
959ccb23 13**/\r
14\r
15#ifndef __PROCESSOR_BIND_H__\r
16#define __PROCESSOR_BIND_H__\r
17\r
3566565a 18///\r
8c18db27 19/// Define the processor type so other code can make processor based choices.\r
3566565a 20///\r
959ccb23 21#define MDE_CPU_IA32\r
22\r
23//\r
3963c4bf 24// Make sure we are using the correct packing rules per EFI specification\r
959ccb23 25//\r
5cfbd055 26#if !defined(__GNUC__)\r
959ccb23 27#pragma pack()\r
28#endif\r
29\r
5cfbd055 30#if defined(__INTEL_COMPILER)\r
ed300ce2 31//\r
32// Disable ICC's remark #869: "Parameter" was never referenced warning.\r
33// This is legal ANSI C code so we disable the remark that is turned on with -Wall\r
34//\r
35#pragma warning ( disable : 869 )\r
36\r
b483e395
A
37//\r
38// Disable ICC's remark #1418: external function definition with no prior declaration.\r
39// This is legal ANSI C code so we disable the remark that is turned on with /W4\r
40//\r
41#pragma warning ( disable : 1418 )\r
42\r
b483e395
A
43//\r
44// Disable ICC's remark #1419: external declaration in primary source file\r
45// This is legal ANSI C code so we disable the remark that is turned on with /W4\r
46//\r
47#pragma warning ( disable : 1419 )\r
48\r
8fe69f13 49//\r
50// Disable ICC's remark #593: "Variable" was set but never used.\r
51// This is legal ANSI C code so we disable the remark that is turned on with /W4\r
52//\r
53#pragma warning ( disable : 593 )\r
54\r
b483e395
A
55#endif\r
56\r
57\r
5cfbd055 58#if defined(_MSC_EXTENSIONS)\r
959ccb23 59\r
60//\r
61// Disable warning that make it impossible to compile at /W4\r
62// This only works for Microsoft* tools\r
63//\r
64\r
65//\r
66// Disabling bitfield type checking warnings.\r
67//\r
68#pragma warning ( disable : 4214 )\r
69\r
70//\r
71// Disabling the unreferenced formal parameter warnings.\r
72//\r
73#pragma warning ( disable : 4100 )\r
74\r
75//\r
76// Disable slightly different base types warning as CHAR8 * can not be set\r
77// to a constant string.\r
78//\r
79#pragma warning ( disable : 4057 )\r
80\r
81//\r
00b7cc0f 82// ASSERT(FALSE) or while (TRUE) are legal constructs so suppress this warning\r
959ccb23 83//\r
84#pragma warning ( disable : 4127 )\r
85\r
86//\r
87// This warning is caused by functions defined but not used. For precompiled header only.\r
88//\r
89#pragma warning ( disable : 4505 )\r
90\r
91//\r
3963c4bf 92// This warning is caused by empty (after preprocessing) source file. For precompiled header only.\r
959ccb23 93//\r
94#pragma warning ( disable : 4206 )\r
95\r
592a3790 96#if _MSC_VER == 1800 || _MSC_VER == 1900\r
a5077fd0
SQ
97\r
98//\r
99// Disable these warnings for VS2013.\r
100//\r
101\r
102//\r
103// This warning is for potentially uninitialized local variable, and it may cause false \r
592a3790 104// positive issues in VS2013 and VS2015 build\r
a5077fd0
SQ
105//\r
106#pragma warning ( disable : 4701 )\r
107 \r
108//\r
109// This warning is for potentially uninitialized local pointer variable, and it may cause \r
592a3790 110// false positive issues in VS2013 and VS2015 build\r
a5077fd0
SQ
111//\r
112#pragma warning ( disable : 4703 )\r
113 \r
114#endif\r
115\r
959ccb23 116#endif\r
117\r
118\r
52aa9e13 119#if defined(_MSC_EXTENSIONS)\r
f4ec40ab 120\r
959ccb23 121 //\r
00b7cc0f 122 // use Microsoft C compiler dependent integer width types\r
959ccb23 123 //\r
f4ec40ab 124\r
52aa9e13 125 ///\r
8c18db27 126 /// 8-byte unsigned value.\r
52aa9e13
EB
127 ///\r
128 typedef unsigned __int64 UINT64;\r
129 ///\r
8c18db27 130 /// 8-byte signed value.\r
52aa9e13
EB
131 ///\r
132 typedef __int64 INT64;\r
133 ///\r
8c18db27 134 /// 4-byte unsigned value.\r
52aa9e13
EB
135 ///\r
136 typedef unsigned __int32 UINT32;\r
137 ///\r
8c18db27 138 /// 4-byte signed value.\r
52aa9e13
EB
139 ///\r
140 typedef __int32 INT32;\r
141 ///\r
8c18db27 142 /// 2-byte unsigned value.\r
52aa9e13
EB
143 ///\r
144 typedef unsigned short UINT16;\r
145 ///\r
146 /// 2-byte Character. Unless otherwise specified all strings are stored in the\r
147 /// UTF-16 encoding format as defined by Unicode 2.1 and ISO/IEC 10646 standards.\r
148 ///\r
149 typedef unsigned short CHAR16;\r
150 ///\r
8c18db27 151 /// 2-byte signed value.\r
52aa9e13
EB
152 ///\r
153 typedef short INT16;\r
f4ec40ab 154 ///\r
155 /// Logical Boolean. 1-byte value containing 0 for FALSE or a 1 for TRUE. Other\r
156 /// values are undefined.\r
157 ///\r
52aa9e13
EB
158 typedef unsigned char BOOLEAN;\r
159 ///\r
8c18db27 160 /// 1-byte unsigned value.\r
52aa9e13
EB
161 ///\r
162 typedef unsigned char UINT8;\r
163 ///\r
8c18db27 164 /// 1-byte Character.\r
52aa9e13
EB
165 ///\r
166 typedef char CHAR8;\r
f4ec40ab 167 ///\r
8c18db27 168 /// 1-byte signed value.\r
f4ec40ab 169 ///\r
d22ebbe3 170 typedef signed char INT8;\r
52aa9e13 171#else \r
f4ec40ab 172 ///\r
8c18db27 173 /// 8-byte unsigned value.\r
f4ec40ab 174 ///\r
52aa9e13 175 typedef unsigned long long UINT64;\r
f4ec40ab 176 ///\r
8c18db27 177 /// 8-byte signed value.\r
f4ec40ab 178 ///\r
52aa9e13 179 typedef long long INT64;\r
f4ec40ab 180 ///\r
8c18db27 181 /// 4-byte unsigned value.\r
f4ec40ab 182 ///\r
52aa9e13 183 typedef unsigned int UINT32;\r
f4ec40ab 184 ///\r
8c18db27 185 /// 4-byte signed value.\r
f4ec40ab 186 ///\r
52aa9e13 187 typedef int INT32;\r
f4ec40ab 188 ///\r
8c18db27 189 /// 2-byte unsigned value.\r
f4ec40ab 190 ///\r
52aa9e13 191 typedef unsigned short UINT16;\r
f4ec40ab 192 ///\r
52aa9e13
EB
193 /// 2-byte Character. Unless otherwise specified all strings are stored in the\r
194 /// UTF-16 encoding format as defined by Unicode 2.1 and ISO/IEC 10646 standards.\r
f4ec40ab 195 ///\r
52aa9e13 196 typedef unsigned short CHAR16;\r
f4ec40ab 197 ///\r
8c18db27 198 /// 2-byte signed value.\r
52aa9e13
EB
199 ///\r
200 typedef short INT16;\r
201 ///\r
202 /// Logical Boolean. 1-byte value containing 0 for FALSE or a 1 for TRUE. Other\r
203 /// values are undefined.\r
f4ec40ab 204 ///\r
52aa9e13
EB
205 typedef unsigned char BOOLEAN;\r
206 ///\r
8c18db27 207 /// 1-byte unsigned value.\r
52aa9e13
EB
208 ///\r
209 typedef unsigned char UINT8;\r
f4ec40ab 210 ///\r
211 /// 1-byte Character\r
212 ///\r
52aa9e13 213 typedef char CHAR8;\r
f4ec40ab 214 ///\r
52aa9e13 215 /// 1-byte signed value\r
f4ec40ab 216 ///\r
d22ebbe3 217 typedef signed char INT8;\r
959ccb23 218#endif\r
219\r
f4ec40ab 220///\r
8c18db27 221/// Unsigned value of native width. (4 bytes on supported 32-bit processor instructions;\r
222/// 8 bytes on supported 64-bit processor instructions.)\r
f4ec40ab 223///\r
959ccb23 224typedef UINT32 UINTN;\r
f4ec40ab 225///\r
8c18db27 226/// Signed value of native width. (4 bytes on supported 32-bit processor instructions;\r
227/// 8 bytes on supported 64-bit processor instructions.)\r
f4ec40ab 228///\r
959ccb23 229typedef INT32 INTN;\r
230\r
f4ec40ab 231//\r
232// Processor specific defines\r
233//\r
959ccb23 234\r
3566565a 235///\r
f4ec40ab 236/// A value of native width with the highest bit set.\r
3566565a 237///\r
959ccb23 238#define MAX_BIT 0x80000000\r
f4ec40ab 239///\r
240/// A value of native width with the two highest bits set.\r
241///\r
959ccb23 242#define MAX_2_BITS 0xC0000000\r
243\r
3566565a 244///\r
8c18db27 245/// Maximum legal IA-32 address.\r
3566565a 246///\r
959ccb23 247#define MAX_ADDRESS 0xFFFFFFFF\r
248\r
068a82fc
LG
249///\r
250/// Maximum legal IA-32 INTN and UINTN values.\r
251///\r
252#define MAX_INTN ((INTN)0x7FFFFFFF)\r
253#define MAX_UINTN ((UINTN)0xFFFFFFFF)\r
254\r
3566565a 255///\r
8c18db27 256/// The stack alignment required for IA-32.\r
3566565a 257///\r
959ccb23 258#define CPU_STACK_ALIGNMENT sizeof(UINTN)\r
259\r
08855193
AB
260///\r
261/// Page allocation granularity for IA-32.\r
262///\r
263#define DEFAULT_PAGE_ALLOCATION_GRANULARITY (0x1000)\r
264#define RUNTIME_PAGE_ALLOCATION_GRANULARITY (0x1000)\r
265\r
959ccb23 266//\r
267// Modifier to ensure that all protocol member functions and EFI intrinsics\r
268// use the correct C calling convention. All protocol member functions and\r
3963c4bf 269// EFI intrinsics are required to modify their member functions with EFIAPI.\r
959ccb23 270//\r
6149e6bb 271#ifdef EFIAPI\r
272 ///\r
273 /// If EFIAPI is already defined, then we use that definition.\r
274 ///\r
275#elif defined(_MSC_EXTENSIONS)\r
3566565a 276 ///\r
8c18db27 277 /// Microsoft* compiler specific method for EFIAPI calling convention.\r
3566565a 278 /// \r
959ccb23 279 #define EFIAPI __cdecl \r
a0e1b127
LG
280#elif defined(__GNUC__)\r
281 ///\r
282 /// GCC specific method for EFIAPI calling convention.\r
283 /// \r
284 #define EFIAPI __attribute__((cdecl)) \r
86b2b825 285#else\r
a0e1b127
LG
286 ///\r
287 /// The default for a non Microsoft* or GCC compiler is to assume the EFI ABI\r
288 /// is the standard. \r
289 ///\r
290 #define EFIAPI\r
959ccb23 291#endif\r
292\r
5cfbd055 293#if defined(__GNUC__)\r
68167fed 294 ///\r
295 /// For GNU assembly code, .global or .globl can declare global symbols.\r
296 /// Define this macro to unify the usage.\r
297 ///\r
298 #define ASM_GLOBAL .globl\r
27af6b87 299#endif\r
300\r
14996c96
LG
301/**\r
302 Return the pointer to the first instruction of a function given a function pointer.\r
1a2f870c 303 On IA-32 CPU architectures, these two pointer values are the same, \r
14996c96
LG
304 so the implementation of this macro is very simple.\r
305 \r
3963c4bf 306 @param FunctionPointer A pointer to a function.\r
14996c96
LG
307\r
308 @return The pointer to the first instruction of a function given a function pointer.\r
3963c4bf 309 \r
14996c96 310**/\r
9a1d00cb 311#define FUNCTION_ENTRY_POINT(FunctionPointer) (VOID *)(UINTN)(FunctionPointer)\r
24a7505c 312\r
02eef553
JJ
313#ifndef __USER_LABEL_PREFIX__\r
314#define __USER_LABEL_PREFIX__ _\r
315#endif\r
316\r
959ccb23 317#endif\r
318\r