Grammatical and disclaimer changes (does not follow internal C coding stds.)
[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
8fe69f13 4 Copyright (c) 2006 - 2010, Intel Corporation<BR> \r
959ccb23 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
959ccb23 13**/\r
14\r
15#ifndef __PROCESSOR_BIND_H__\r
16#define __PROCESSOR_BIND_H__\r
17\r
3566565a 18///\r
19/// Define the processor type so other code can make processor based choices\r
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
EB
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
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
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
f4ec40ab 147 ///\r
148 /// 1-byte signed value\r
149 ///\r
52aa9e13
EB
150 typedef char INT8;\r
151#else \r
f4ec40ab 152 ///\r
52aa9e13 153 /// 8-byte unsigned value\r
f4ec40ab 154 ///\r
52aa9e13 155 typedef unsigned long long UINT64;\r
f4ec40ab 156 ///\r
52aa9e13 157 /// 8-byte signed value\r
f4ec40ab 158 ///\r
52aa9e13 159 typedef long long INT64;\r
f4ec40ab 160 ///\r
52aa9e13 161 /// 4-byte unsigned value\r
f4ec40ab 162 ///\r
52aa9e13 163 typedef unsigned int UINT32;\r
f4ec40ab 164 ///\r
165 /// 4-byte signed value\r
166 ///\r
52aa9e13 167 typedef int INT32;\r
f4ec40ab 168 ///\r
52aa9e13 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
52aa9e13
EB
178 /// 2-byte signed value\r
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
187 /// 1-byte unsigned value\r
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
52aa9e13 197 typedef char INT8;\r
959ccb23 198#endif\r
199\r
f4ec40ab 200///\r
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
203///\r
959ccb23 204typedef UINT32 UINTN;\r
f4ec40ab 205///\r
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
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
225/// Maximum legal IA-32 address\r
226///\r
959ccb23 227#define MAX_ADDRESS 0xFFFFFFFF\r
228\r
3566565a 229///\r
230/// The stack alignment required for IA-32\r
231///\r
959ccb23 232#define CPU_STACK_ALIGNMENT sizeof(UINTN)\r
233\r
234//\r
235// Modifier to ensure that all protocol member functions and EFI intrinsics\r
236// use the correct C calling convention. All protocol member functions and\r
3963c4bf 237// EFI intrinsics are required to modify their member functions with EFIAPI.\r
959ccb23 238//\r
6149e6bb 239#ifdef EFIAPI\r
240 ///\r
241 /// If EFIAPI is already defined, then we use that definition.\r
242 ///\r
243#elif defined(_MSC_EXTENSIONS)\r
3566565a 244 ///\r
f4ec40ab 245 /// Microsoft* compiler specific method for EFIAPI calling convension\r
3566565a 246 /// \r
959ccb23 247 #define EFIAPI __cdecl \r
86b2b825 248#else\r
5cfbd055 249 #if defined(__GNUC__)\r
f4ec40ab 250 ///\r
251 /// GCC specific method for EFIAPI calling convension\r
252 /// \r
86b2b825 253 #define EFIAPI __attribute__((cdecl)) \r
254 #endif \r
959ccb23 255#endif\r
256\r
5cfbd055 257#if defined(__GNUC__)\r
68167fed 258 ///\r
259 /// For GNU assembly code, .global or .globl can declare global symbols.\r
260 /// Define this macro to unify the usage.\r
261 ///\r
262 #define ASM_GLOBAL .globl\r
27af6b87 263#endif\r
264\r
14996c96
LG
265/**\r
266 Return the pointer to the first instruction of a function given a function pointer.\r
1a2f870c 267 On IA-32 CPU architectures, these two pointer values are the same, \r
14996c96
LG
268 so the implementation of this macro is very simple.\r
269 \r
3963c4bf 270 @param FunctionPointer A pointer to a function.\r
14996c96
LG
271\r
272 @return The pointer to the first instruction of a function given a function pointer.\r
3963c4bf 273 \r
14996c96 274**/\r
9a1d00cb 275#define FUNCTION_ENTRY_POINT(FunctionPointer) (VOID *)(UINTN)(FunctionPointer)\r
24a7505c 276\r
959ccb23 277#endif\r
278\r