MdeModulePkg DxePrintLibPrint2Protocol Library SPrintLength() API issue.
[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
068a82fc 4Copyright (c) 2006 - 2013, 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
82// ASSERT(FALSE) or while (TRUE) are legal constructes so supress this warning\r
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
96#endif\r
97\r
98\r
52aa9e13 99#if defined(_MSC_EXTENSIONS)\r
f4ec40ab 100\r
959ccb23 101 //\r
52aa9e13 102 // use Microsoft C complier dependent integer width types \r
959ccb23 103 //\r
f4ec40ab 104\r
52aa9e13 105 ///\r
8c18db27 106 /// 8-byte unsigned value.\r
52aa9e13
EB
107 ///\r
108 typedef unsigned __int64 UINT64;\r
109 ///\r
8c18db27 110 /// 8-byte signed value.\r
52aa9e13
EB
111 ///\r
112 typedef __int64 INT64;\r
113 ///\r
8c18db27 114 /// 4-byte unsigned value.\r
52aa9e13
EB
115 ///\r
116 typedef unsigned __int32 UINT32;\r
117 ///\r
8c18db27 118 /// 4-byte signed value.\r
52aa9e13
EB
119 ///\r
120 typedef __int32 INT32;\r
121 ///\r
8c18db27 122 /// 2-byte unsigned value.\r
52aa9e13
EB
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
8c18db27 131 /// 2-byte signed value.\r
52aa9e13
EB
132 ///\r
133 typedef short INT16;\r
f4ec40ab 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
52aa9e13
EB
138 typedef unsigned char BOOLEAN;\r
139 ///\r
8c18db27 140 /// 1-byte unsigned value.\r
52aa9e13
EB
141 ///\r
142 typedef unsigned char UINT8;\r
143 ///\r
8c18db27 144 /// 1-byte Character.\r
52aa9e13
EB
145 ///\r
146 typedef char CHAR8;\r
f4ec40ab 147 ///\r
8c18db27 148 /// 1-byte signed value.\r
f4ec40ab 149 ///\r
d22ebbe3 150 typedef signed char INT8;\r
52aa9e13 151#else \r
f4ec40ab 152 ///\r
8c18db27 153 /// 8-byte unsigned value.\r
f4ec40ab 154 ///\r
52aa9e13 155 typedef unsigned long long UINT64;\r
f4ec40ab 156 ///\r
8c18db27 157 /// 8-byte signed value.\r
f4ec40ab 158 ///\r
52aa9e13 159 typedef long long INT64;\r
f4ec40ab 160 ///\r
8c18db27 161 /// 4-byte unsigned value.\r
f4ec40ab 162 ///\r
52aa9e13 163 typedef unsigned int UINT32;\r
f4ec40ab 164 ///\r
8c18db27 165 /// 4-byte signed value.\r
f4ec40ab 166 ///\r
52aa9e13 167 typedef int INT32;\r
f4ec40ab 168 ///\r
8c18db27 169 /// 2-byte unsigned value.\r
f4ec40ab 170 ///\r
52aa9e13 171 typedef unsigned short UINT16;\r
f4ec40ab 172 ///\r
52aa9e13
EB
173 /// 2-byte Character. Unless otherwise specified all strings are stored in the\r
174 /// UTF-16 encoding format as defined by Unicode 2.1 and ISO/IEC 10646 standards.\r
f4ec40ab 175 ///\r
52aa9e13 176 typedef unsigned short CHAR16;\r
f4ec40ab 177 ///\r
8c18db27 178 /// 2-byte signed value.\r
52aa9e13
EB
179 ///\r
180 typedef short INT16;\r
181 ///\r
182 /// Logical Boolean. 1-byte value containing 0 for FALSE or a 1 for TRUE. Other\r
183 /// values are undefined.\r
f4ec40ab 184 ///\r
52aa9e13
EB
185 typedef unsigned char BOOLEAN;\r
186 ///\r
8c18db27 187 /// 1-byte unsigned value.\r
52aa9e13
EB
188 ///\r
189 typedef unsigned char UINT8;\r
f4ec40ab 190 ///\r
191 /// 1-byte Character\r
192 ///\r
52aa9e13 193 typedef char CHAR8;\r
f4ec40ab 194 ///\r
52aa9e13 195 /// 1-byte signed value\r
f4ec40ab 196 ///\r
d22ebbe3 197 typedef signed char INT8;\r
959ccb23 198#endif\r
199\r
f4ec40ab 200///\r
8c18db27 201/// Unsigned value of native width. (4 bytes on supported 32-bit processor instructions;\r
202/// 8 bytes on supported 64-bit processor instructions.)\r
f4ec40ab 203///\r
959ccb23 204typedef UINT32 UINTN;\r
f4ec40ab 205///\r
8c18db27 206/// Signed value of native width. (4 bytes on supported 32-bit processor instructions;\r
207/// 8 bytes on supported 64-bit processor instructions.)\r
f4ec40ab 208///\r
959ccb23 209typedef INT32 INTN;\r
210\r
f4ec40ab 211//\r
212// Processor specific defines\r
213//\r
959ccb23 214\r
3566565a 215///\r
f4ec40ab 216/// A value of native width with the highest bit set.\r
3566565a 217///\r
959ccb23 218#define MAX_BIT 0x80000000\r
f4ec40ab 219///\r
220/// A value of native width with the two highest bits set.\r
221///\r
959ccb23 222#define MAX_2_BITS 0xC0000000\r
223\r
3566565a 224///\r
8c18db27 225/// Maximum legal IA-32 address.\r
3566565a 226///\r
959ccb23 227#define MAX_ADDRESS 0xFFFFFFFF\r
228\r
068a82fc
LG
229///\r
230/// Maximum legal IA-32 INTN and UINTN values.\r
231///\r
232#define MAX_INTN ((INTN)0x7FFFFFFF)\r
233#define MAX_UINTN ((UINTN)0xFFFFFFFF)\r
234\r
3566565a 235///\r
8c18db27 236/// The stack alignment required for IA-32.\r
3566565a 237///\r
959ccb23 238#define CPU_STACK_ALIGNMENT sizeof(UINTN)\r
239\r
240//\r
241// Modifier to ensure that all protocol member functions and EFI intrinsics\r
242// use the correct C calling convention. All protocol member functions and\r
3963c4bf 243// EFI intrinsics are required to modify their member functions with EFIAPI.\r
959ccb23 244//\r
6149e6bb 245#ifdef EFIAPI\r
246 ///\r
247 /// If EFIAPI is already defined, then we use that definition.\r
248 ///\r
249#elif defined(_MSC_EXTENSIONS)\r
3566565a 250 ///\r
8c18db27 251 /// Microsoft* compiler specific method for EFIAPI calling convention.\r
3566565a 252 /// \r
959ccb23 253 #define EFIAPI __cdecl \r
a0e1b127
LG
254#elif defined(__GNUC__)\r
255 ///\r
256 /// GCC specific method for EFIAPI calling convention.\r
257 /// \r
258 #define EFIAPI __attribute__((cdecl)) \r
86b2b825 259#else\r
a0e1b127
LG
260 ///\r
261 /// The default for a non Microsoft* or GCC compiler is to assume the EFI ABI\r
262 /// is the standard. \r
263 ///\r
264 #define EFIAPI\r
959ccb23 265#endif\r
266\r
5cfbd055 267#if defined(__GNUC__)\r
68167fed 268 ///\r
269 /// For GNU assembly code, .global or .globl can declare global symbols.\r
270 /// Define this macro to unify the usage.\r
271 ///\r
272 #define ASM_GLOBAL .globl\r
27af6b87 273#endif\r
274\r
14996c96
LG
275/**\r
276 Return the pointer to the first instruction of a function given a function pointer.\r
1a2f870c 277 On IA-32 CPU architectures, these two pointer values are the same, \r
14996c96
LG
278 so the implementation of this macro is very simple.\r
279 \r
3963c4bf 280 @param FunctionPointer A pointer to a function.\r
14996c96
LG
281\r
282 @return The pointer to the first instruction of a function given a function pointer.\r
3963c4bf 283 \r
14996c96 284**/\r
9a1d00cb 285#define FUNCTION_ENTRY_POINT(FunctionPointer) (VOID *)(UINTN)(FunctionPointer)\r
24a7505c 286\r
02eef553
JJ
287#ifndef __USER_LABEL_PREFIX__\r
288#define __USER_LABEL_PREFIX__ _\r
289#endif\r
290\r
959ccb23 291#endif\r
292\r