]>
Commit | Line | Data |
---|---|---|
959ccb23 | 1 | /** @file\r |
959ccb23 | 2 | Root include file for Mde Package Base type modules\r |
3 | \r | |
818ff8c2 | 4 | This is the include file for any module of type base. Base modules only use\r |
5 | types defined via this include file and can be ported easily to any\r | |
959ccb23 | 6 | environment. There are a set of base libraries in the Mde Package that can\r |
7 | be used to implement base modules.\r | |
8 | \r | |
ab4de5c8 | 9 | Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>\r |
9df063a0 HT |
10 | Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>\r |
11 | This program and the accompanying materials\r | |
959ccb23 | 12 | are licensed and made available under the terms and conditions of the BSD License\r |
13 | which accompanies this distribution. The full text of the license may be found at\r | |
af2dc6a7 | 14 | http://opensource.org/licenses/bsd-license.php.\r |
959ccb23 | 15 | \r |
16 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
17 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
18 | \r | |
19 | **/\r | |
20 | \r | |
21 | \r | |
22 | #ifndef __BASE_H__\r | |
23 | #define __BASE_H__\r | |
24 | \r | |
25 | //\r | |
26 | // Include processor specific binding\r | |
27 | //\r | |
28 | #include <ProcessorBind.h>\r | |
29 | \r | |
7849538e MK |
30 | #if defined(_MSC_EXTENSIONS)\r |
31 | //\r | |
32 | // Disable warning when last field of data structure is a zero sized array.\r | |
33 | //\r | |
34 | #pragma warning ( disable : 4200 )\r | |
35 | #endif\r | |
6c3fa13c | 36 | \r |
37 | /**\r | |
38 | Verifies the storage size of a given data type.\r | |
818ff8c2 | 39 | \r |
6c3fa13c | 40 | This macro generates a divide by zero error or a zero size array declaration in\r |
41 | the preprocessor if the size is incorrect. These are declared as "extern" so\r | |
42 | the space for these arrays will not be in the modules.\r | |
43 | \r | |
44 | @param TYPE The date type to determine the size of.\r | |
45 | @param Size The expected size for the TYPE.\r | |
46 | \r | |
47 | **/\r | |
48 | #define VERIFY_SIZE_OF(TYPE, Size) extern UINT8 _VerifySizeof##TYPE[(sizeof(TYPE) == (Size)) / (sizeof(TYPE) == (Size))]\r | |
49 | \r | |
52aa9e13 | 50 | //\r |
818ff8c2 | 51 | // Verify that ProcessorBind.h produced UEFI Data Types that are compliant with\r |
52 | // Section 2.3.1 of the UEFI 2.3 Specification.\r | |
52aa9e13 | 53 | //\r |
6c3fa13c | 54 | VERIFY_SIZE_OF (BOOLEAN, 1);\r |
55 | VERIFY_SIZE_OF (INT8, 1);\r | |
56 | VERIFY_SIZE_OF (UINT8, 1);\r | |
57 | VERIFY_SIZE_OF (INT16, 2);\r | |
58 | VERIFY_SIZE_OF (UINT16, 2);\r | |
59 | VERIFY_SIZE_OF (INT32, 4);\r | |
60 | VERIFY_SIZE_OF (UINT32, 4);\r | |
61 | VERIFY_SIZE_OF (INT64, 8);\r | |
62 | VERIFY_SIZE_OF (UINT64, 8);\r | |
63 | VERIFY_SIZE_OF (CHAR8, 1);\r | |
64 | VERIFY_SIZE_OF (CHAR16, 2);\r | |
52aa9e13 | 65 | \r |
bd5ef826 LG |
66 | //\r |
67 | // The following three enum types are used to verify that the compiler\r | |
68 | // configuration for enum types is compliant with Section 2.3.1 of the \r | |
69 | // UEFI 2.3 Specification. These enum types and enum values are not \r | |
70 | // intended to be used. A prefix of '__' is used avoid conflicts with\r | |
71 | // other types.\r | |
72 | //\r | |
6440385b MK |
73 | typedef enum {\r |
74 | __VerifyUint8EnumValue = 0xff\r | |
75 | } __VERIFY_UINT8_ENUM_SIZE;\r | |
76 | \r | |
77 | typedef enum {\r | |
78 | __VerifyUint16EnumValue = 0xffff\r | |
79 | } __VERIFY_UINT16_ENUM_SIZE;\r | |
80 | \r | |
81 | typedef enum {\r | |
82 | __VerifyUint32EnumValue = 0xffffffff\r | |
83 | } __VERIFY_UINT32_ENUM_SIZE;\r | |
84 | \r | |
85 | VERIFY_SIZE_OF (__VERIFY_UINT8_ENUM_SIZE, 4);\r | |
86 | VERIFY_SIZE_OF (__VERIFY_UINT16_ENUM_SIZE, 4);\r | |
87 | VERIFY_SIZE_OF (__VERIFY_UINT32_ENUM_SIZE, 4);\r | |
88 | \r | |
dda3a6ce | 89 | //\r |
90 | // The Microsoft* C compiler can removed references to unreferenced data items\r | |
818ff8c2 | 91 | // if the /OPT:REF linker option is used. We defined a macro as this is a\r |
dda3a6ce | 92 | // a non standard extension\r |
93 | //\r | |
b243ead0 | 94 | #if defined(_MSC_EXTENSIONS) && _MSC_VER < 1800 && !defined (MDE_CPU_EBC)\r |
dda3a6ce | 95 | ///\r |
818ff8c2 | 96 | /// Remove global variable from the linked image if there are no references to\r |
dda3a6ce | 97 | /// it after all compiler and linker optimizations have been performed.\r |
98 | ///\r | |
99 | ///\r | |
100 | #define GLOBAL_REMOVE_IF_UNREFERENCED __declspec(selectany)\r | |
101 | #else\r | |
102 | ///\r | |
818ff8c2 | 103 | /// Remove the global variable from the linked image if there are no references\r |
af2dc6a7 | 104 | /// to it after all compiler and linker optimizations have been performed.\r |
dda3a6ce | 105 | ///\r |
106 | ///\r | |
107 | #define GLOBAL_REMOVE_IF_UNREFERENCED\r | |
108 | #endif\r | |
109 | \r | |
001f28ca MH |
110 | //\r |
111 | // Should be used in combination with NORETURN to avoid 'noreturn' returns\r | |
112 | // warnings.\r | |
113 | //\r | |
114 | #ifndef UNREACHABLE\r | |
357cec38 | 115 | #if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ > 4)\r |
001f28ca MH |
116 | ///\r |
117 | /// Signal compilers and analyzers that this call is not reachable. It is\r | |
118 | /// up to the compiler to remove any code past that point.\r | |
357cec38 | 119 | /// Not implemented by GCC 4.4 or earlier.\r |
001f28ca MH |
120 | ///\r |
121 | #define UNREACHABLE() __builtin_unreachable ()\r | |
122 | #elif defined (__has_feature)\r | |
123 | #if __has_builtin (__builtin_unreachable)\r | |
124 | ///\r | |
125 | /// Signal compilers and analyzers that this call is not reachable. It is\r | |
126 | /// up to the compiler to remove any code past that point.\r | |
127 | ///\r | |
128 | #define UNREACHABLE() __builtin_unreachable ()\r | |
129 | #endif\r | |
130 | #endif\r | |
131 | \r | |
132 | #ifndef UNREACHABLE\r | |
133 | ///\r | |
134 | /// Signal compilers and analyzers that this call is not reachable. It is\r | |
135 | /// up to the compiler to remove any code past that point.\r | |
136 | ///\r | |
137 | #define UNREACHABLE()\r | |
138 | #endif\r | |
139 | #endif\r | |
140 | \r | |
141 | //\r | |
142 | // Signaling compilers and analyzers that a certain function cannot return may\r | |
143 | // remove all following code and thus lead to better optimization and less\r | |
144 | // false positives.\r | |
145 | //\r | |
146 | #ifndef NORETURN\r | |
147 | #if defined (__GNUC__) || defined (__clang__)\r | |
148 | ///\r | |
149 | /// Signal compilers and analyzers that the function cannot return.\r | |
150 | /// It is up to the compiler to remove any code past a call to functions\r | |
151 | /// flagged with this attribute.\r | |
152 | ///\r | |
153 | #define NORETURN __attribute__((noreturn))\r | |
154 | #elif defined(_MSC_EXTENSIONS) && !defined(MDE_CPU_EBC)\r | |
155 | ///\r | |
156 | /// Signal compilers and analyzers that the function cannot return.\r | |
157 | /// It is up to the compiler to remove any code past a call to functions\r | |
158 | /// flagged with this attribute.\r | |
159 | ///\r | |
160 | #define NORETURN __declspec(noreturn)\r | |
161 | #else\r | |
162 | ///\r | |
163 | /// Signal compilers and analyzers that the function cannot return.\r | |
164 | /// It is up to the compiler to remove any code past a call to functions\r | |
165 | /// flagged with this attribute.\r | |
166 | ///\r | |
167 | #define NORETURN\r | |
168 | #endif\r | |
169 | #endif\r | |
170 | \r | |
171 | //\r | |
172 | // Should be used in combination with ANALYZER_NORETURN to avoid 'noreturn'\r | |
173 | // returns warnings.\r | |
174 | //\r | |
175 | #ifndef ANALYZER_UNREACHABLE\r | |
176 | #ifdef __clang_analyzer__\r | |
177 | #if __has_builtin (__builtin_unreachable)\r | |
178 | ///\r | |
179 | /// Signal the analyzer that this call is not reachable.\r | |
180 | /// This excludes compilers.\r | |
181 | ///\r | |
182 | #define ANALYZER_UNREACHABLE() __builtin_unreachable ()\r | |
183 | #endif\r | |
184 | #endif\r | |
185 | \r | |
186 | #ifndef ANALYZER_UNREACHABLE\r | |
187 | ///\r | |
188 | /// Signal the analyzer that this call is not reachable.\r | |
189 | /// This excludes compilers.\r | |
190 | ///\r | |
191 | #define ANALYZER_UNREACHABLE()\r | |
192 | #endif\r | |
193 | #endif\r | |
194 | \r | |
195 | //\r | |
196 | // Static Analyzers may issue errors about potential NULL-dereferences when\r | |
197 | // dereferencing a pointer, that has been checked before, outside of a\r | |
198 | // NULL-check. This may lead to false positives, such as when using ASSERT()\r | |
199 | // for verification.\r | |
200 | //\r | |
201 | #ifndef ANALYZER_NORETURN\r | |
202 | #ifdef __has_feature\r | |
203 | #if __has_feature (attribute_analyzer_noreturn)\r | |
204 | ///\r | |
205 | /// Signal analyzers that the function cannot return.\r | |
206 | /// This excludes compilers.\r | |
207 | ///\r | |
208 | #define ANALYZER_NORETURN __attribute__((analyzer_noreturn))\r | |
209 | #endif\r | |
210 | #endif\r | |
211 | \r | |
212 | #ifndef ANALYZER_NORETURN\r | |
213 | ///\r | |
214 | /// Signal the analyzer that the function cannot return.\r | |
215 | /// This excludes compilers.\r | |
216 | ///\r | |
217 | #define ANALYZER_NORETURN\r | |
218 | #endif\r | |
219 | #endif\r | |
220 | \r | |
2d94c38b M |
221 | ///\r |
222 | /// Tell the code optimizer that the function will return twice.\r | |
223 | /// This prevents wrong optimizations which can cause bugs.\r | |
224 | ///\r | |
225 | #ifndef RETURNS_TWICE\r | |
226 | #if defined (__GNUC__) || defined (__clang__)\r | |
227 | ///\r | |
228 | /// Tell the code optimizer that the function will return twice.\r | |
229 | /// This prevents wrong optimizations which can cause bugs.\r | |
230 | ///\r | |
231 | #define RETURNS_TWICE __attribute__((returns_twice))\r | |
232 | #else\r | |
233 | ///\r | |
234 | /// Tell the code optimizer that the function will return twice.\r | |
235 | /// This prevents wrong optimizations which can cause bugs.\r | |
236 | ///\r | |
237 | #define RETURNS_TWICE\r | |
238 | #endif\r | |
239 | #endif\r | |
240 | \r | |
dda3a6ce | 241 | //\r |
02eef553 | 242 | // For symbol name in assembly code, an extra "_" is sometimes necessary\r |
dda3a6ce | 243 | //\r |
dda3a6ce | 244 | \r |
02eef553 JJ |
245 | ///\r |
246 | /// Private worker functions for ASM_PFX()\r | |
247 | ///\r | |
248 | #define _CONCATENATE(a, b) __CONCATENATE(a, b)\r | |
249 | #define __CONCATENATE(a, b) a ## b\r | |
250 | \r | |
251 | ///\r | |
252 | /// The __USER_LABEL_PREFIX__ macro predefined by GNUC represents the prefix\r | |
253 | /// on symbols in assembly language.\r | |
254 | ///\r | |
255 | #define ASM_PFX(name) _CONCATENATE (__USER_LABEL_PREFIX__, name)\r | |
dda3a6ce | 256 | \r |
257 | #if __APPLE__\r | |
258 | //\r | |
818ff8c2 | 259 | // Apple extension that is used by the linker to optimize code size\r |
dda3a6ce | 260 | // with assembly functions. Put at the end of your .S files\r |
261 | //\r | |
262 | #define ASM_FUNCTION_REMOVE_IF_UNREFERENCED .subsections_via_symbols\r | |
263 | #else\r | |
264 | #define ASM_FUNCTION_REMOVE_IF_UNREFERENCED\r | |
265 | #endif\r | |
266 | \r | |
267 | #ifdef __CC_ARM\r | |
268 | //\r | |
818ff8c2 | 269 | // Older RVCT ARM compilers don't fully support #pragma pack and require __packed\r |
dda3a6ce | 270 | // as a prefix for the structure.\r |
271 | //\r | |
272 | #define PACKED __packed\r | |
273 | #else\r | |
274 | #define PACKED\r | |
275 | #endif\r | |
276 | \r | |
f4ec40ab | 277 | ///\r |
818ff8c2 | 278 | /// 128 bit buffer containing a unique identifier value.\r |
f4ec40ab | 279 | /// Unless otherwise specified, aligned on a 64 bit boundary.\r |
280 | ///\r | |
959ccb23 | 281 | typedef struct {\r |
282 | UINT32 Data1;\r | |
283 | UINT16 Data2;\r | |
284 | UINT16 Data3;\r | |
285 | UINT8 Data4[8];\r | |
286 | } GUID;\r | |
287 | \r | |
ab4de5c8 RN |
288 | ///\r |
289 | /// 4-byte buffer. An IPv4 internet protocol address.\r | |
290 | ///\r | |
291 | typedef struct {\r | |
292 | UINT8 Addr[4];\r | |
293 | } IPv4_ADDRESS;\r | |
294 | \r | |
295 | ///\r | |
296 | /// 16-byte buffer. An IPv6 internet protocol address.\r | |
297 | ///\r | |
298 | typedef struct {\r | |
299 | UINT8 Addr[16];\r | |
300 | } IPv6_ADDRESS;\r | |
301 | \r | |
3963c4bf | 302 | //\r |
303 | // 8-bytes unsigned value that represents a physical system address.\r | |
304 | //\r | |
959ccb23 | 305 | typedef UINT64 PHYSICAL_ADDRESS;\r |
306 | \r | |
62991af2 | 307 | ///\r |
f4ec40ab | 308 | /// LIST_ENTRY structure definition.\r |
62991af2 | 309 | ///\r |
959ccb23 | 310 | typedef struct _LIST_ENTRY LIST_ENTRY;\r |
311 | \r | |
f4ec40ab | 312 | ///\r |
313 | /// _LIST_ENTRY structure definition.\r | |
314 | ///\r | |
959ccb23 | 315 | struct _LIST_ENTRY {\r |
316 | LIST_ENTRY *ForwardLink;\r | |
317 | LIST_ENTRY *BackLink;\r | |
318 | };\r | |
319 | \r | |
320 | //\r | |
3963c4bf | 321 | // Modifiers to abstract standard types to aid in debug of problems\r |
959ccb23 | 322 | //\r |
f4ec40ab | 323 | \r |
324 | ///\r | |
af2dc6a7 | 325 | /// Datum is read-only.\r |
f4ec40ab | 326 | ///\r |
959ccb23 | 327 | #define CONST const\r |
f4ec40ab | 328 | \r |
329 | ///\r | |
af2dc6a7 | 330 | /// Datum is scoped to the current file or function.\r |
f4ec40ab | 331 | ///\r |
959ccb23 | 332 | #define STATIC static\r |
f4ec40ab | 333 | \r |
334 | ///\r | |
af2dc6a7 | 335 | /// Undeclared type.\r |
f4ec40ab | 336 | ///\r |
959ccb23 | 337 | #define VOID void\r |
338 | \r | |
339 | //\r | |
340 | // Modifiers for Data Types used to self document code.\r | |
341 | // This concept is borrowed for UEFI specification.\r | |
342 | //\r | |
f4ec40ab | 343 | \r |
344 | ///\r | |
af2dc6a7 | 345 | /// Datum is passed to the function.\r |
f4ec40ab | 346 | ///\r |
959ccb23 | 347 | #define IN\r |
f4ec40ab | 348 | \r |
349 | ///\r | |
af2dc6a7 | 350 | /// Datum is returned from the function.\r |
f4ec40ab | 351 | ///\r |
959ccb23 | 352 | #define OUT\r |
f4ec40ab | 353 | \r |
354 | ///\r | |
355 | /// Passing the datum to the function is optional, and a NULL\r | |
af2dc6a7 | 356 | /// is passed if the value is not supplied.\r |
f4ec40ab | 357 | ///\r |
959ccb23 | 358 | #define OPTIONAL\r |
959ccb23 | 359 | \r |
959ccb23 | 360 | //\r |
818ff8c2 | 361 | // UEFI specification claims 1 and 0. We are concerned about the\r |
00b7cc0f | 362 | // compiler portability so we did it this way.\r |
959ccb23 | 363 | //\r |
f4ec40ab | 364 | \r |
365 | ///\r | |
366 | /// Boolean true value. UEFI Specification defines this value to be 1,\r | |
367 | /// but this form is more portable.\r | |
368 | ///\r | |
959ccb23 | 369 | #define TRUE ((BOOLEAN)(1==1))\r |
f4ec40ab | 370 | \r |
371 | ///\r | |
372 | /// Boolean false value. UEFI Specification defines this value to be 0,\r | |
373 | /// but this form is more portable.\r | |
374 | ///\r | |
959ccb23 | 375 | #define FALSE ((BOOLEAN)(0==1))\r |
959ccb23 | 376 | \r |
f4ec40ab | 377 | ///\r |
378 | /// NULL pointer (VOID *)\r | |
379 | ///\r | |
959ccb23 | 380 | #define NULL ((VOID *) 0)\r |
959ccb23 | 381 | \r |
0c45a5b2 SB |
382 | //\r |
383 | // Null character\r | |
384 | //\r | |
385 | #define CHAR_NULL 0x0000\r | |
386 | \r | |
068a82fc LG |
387 | ///\r |
388 | /// Maximum values for common UEFI Data Types\r | |
389 | ///\r | |
390 | #define MAX_INT8 ((INT8)0x7F)\r | |
391 | #define MAX_UINT8 ((UINT8)0xFF)\r | |
392 | #define MAX_INT16 ((INT16)0x7FFF)\r | |
393 | #define MAX_UINT16 ((UINT16)0xFFFF)\r | |
394 | #define MAX_INT32 ((INT32)0x7FFFFFFF)\r | |
395 | #define MAX_UINT32 ((UINT32)0xFFFFFFFF)\r | |
396 | #define MAX_INT64 ((INT64)0x7FFFFFFFFFFFFFFFULL)\r | |
397 | #define MAX_UINT64 ((UINT64)0xFFFFFFFFFFFFFFFFULL)\r | |
3963c4bf | 398 | \r |
d7a09cb8 SB |
399 | ///\r |
400 | /// Minimum values for the signed UEFI Data Types\r | |
401 | ///\r | |
402 | #define MIN_INT8 (((INT8) -127) - 1)\r | |
403 | #define MIN_INT16 (((INT16) -32767) - 1)\r | |
404 | #define MIN_INT32 (((INT32) -2147483647) - 1)\r | |
405 | #define MIN_INT64 (((INT64) -9223372036854775807LL) - 1)\r | |
406 | \r | |
959ccb23 | 407 | #define BIT0 0x00000001\r |
408 | #define BIT1 0x00000002\r | |
409 | #define BIT2 0x00000004\r | |
410 | #define BIT3 0x00000008\r | |
411 | #define BIT4 0x00000010\r | |
412 | #define BIT5 0x00000020\r | |
413 | #define BIT6 0x00000040\r | |
414 | #define BIT7 0x00000080\r | |
415 | #define BIT8 0x00000100\r | |
416 | #define BIT9 0x00000200\r | |
417 | #define BIT10 0x00000400\r | |
418 | #define BIT11 0x00000800\r | |
419 | #define BIT12 0x00001000\r | |
420 | #define BIT13 0x00002000\r | |
421 | #define BIT14 0x00004000\r | |
422 | #define BIT15 0x00008000\r | |
423 | #define BIT16 0x00010000\r | |
424 | #define BIT17 0x00020000\r | |
425 | #define BIT18 0x00040000\r | |
426 | #define BIT19 0x00080000\r | |
427 | #define BIT20 0x00100000\r | |
428 | #define BIT21 0x00200000\r | |
429 | #define BIT22 0x00400000\r | |
430 | #define BIT23 0x00800000\r | |
431 | #define BIT24 0x01000000\r | |
432 | #define BIT25 0x02000000\r | |
433 | #define BIT26 0x04000000\r | |
434 | #define BIT27 0x08000000\r | |
435 | #define BIT28 0x10000000\r | |
436 | #define BIT29 0x20000000\r | |
437 | #define BIT30 0x40000000\r | |
438 | #define BIT31 0x80000000\r | |
4d24730c | 439 | #define BIT32 0x0000000100000000ULL\r |
440 | #define BIT33 0x0000000200000000ULL\r | |
441 | #define BIT34 0x0000000400000000ULL\r | |
442 | #define BIT35 0x0000000800000000ULL\r | |
443 | #define BIT36 0x0000001000000000ULL\r | |
444 | #define BIT37 0x0000002000000000ULL\r | |
445 | #define BIT38 0x0000004000000000ULL\r | |
446 | #define BIT39 0x0000008000000000ULL\r | |
447 | #define BIT40 0x0000010000000000ULL\r | |
448 | #define BIT41 0x0000020000000000ULL\r | |
449 | #define BIT42 0x0000040000000000ULL\r | |
450 | #define BIT43 0x0000080000000000ULL\r | |
451 | #define BIT44 0x0000100000000000ULL\r | |
452 | #define BIT45 0x0000200000000000ULL\r | |
453 | #define BIT46 0x0000400000000000ULL\r | |
454 | #define BIT47 0x0000800000000000ULL\r | |
455 | #define BIT48 0x0001000000000000ULL\r | |
456 | #define BIT49 0x0002000000000000ULL\r | |
457 | #define BIT50 0x0004000000000000ULL\r | |
458 | #define BIT51 0x0008000000000000ULL\r | |
459 | #define BIT52 0x0010000000000000ULL\r | |
460 | #define BIT53 0x0020000000000000ULL\r | |
461 | #define BIT54 0x0040000000000000ULL\r | |
462 | #define BIT55 0x0080000000000000ULL\r | |
463 | #define BIT56 0x0100000000000000ULL\r | |
464 | #define BIT57 0x0200000000000000ULL\r | |
465 | #define BIT58 0x0400000000000000ULL\r | |
466 | #define BIT59 0x0800000000000000ULL\r | |
467 | #define BIT60 0x1000000000000000ULL\r | |
468 | #define BIT61 0x2000000000000000ULL\r | |
469 | #define BIT62 0x4000000000000000ULL\r | |
470 | #define BIT63 0x8000000000000000ULL\r | |
959ccb23 | 471 | \r |
2e121e9a | 472 | #define SIZE_1KB 0x00000400\r |
473 | #define SIZE_2KB 0x00000800\r | |
474 | #define SIZE_4KB 0x00001000\r | |
475 | #define SIZE_8KB 0x00002000\r | |
476 | #define SIZE_16KB 0x00004000\r | |
477 | #define SIZE_32KB 0x00008000\r | |
478 | #define SIZE_64KB 0x00010000\r | |
479 | #define SIZE_128KB 0x00020000\r | |
480 | #define SIZE_256KB 0x00040000\r | |
481 | #define SIZE_512KB 0x00080000\r | |
482 | #define SIZE_1MB 0x00100000\r | |
483 | #define SIZE_2MB 0x00200000\r | |
484 | #define SIZE_4MB 0x00400000\r | |
485 | #define SIZE_8MB 0x00800000\r | |
486 | #define SIZE_16MB 0x01000000\r | |
487 | #define SIZE_32MB 0x02000000\r | |
488 | #define SIZE_64MB 0x04000000\r | |
489 | #define SIZE_128MB 0x08000000\r | |
490 | #define SIZE_256MB 0x10000000\r | |
491 | #define SIZE_512MB 0x20000000\r | |
492 | #define SIZE_1GB 0x40000000\r | |
493 | #define SIZE_2GB 0x80000000\r | |
494 | #define SIZE_4GB 0x0000000100000000ULL\r | |
495 | #define SIZE_8GB 0x0000000200000000ULL\r | |
496 | #define SIZE_16GB 0x0000000400000000ULL\r | |
497 | #define SIZE_32GB 0x0000000800000000ULL\r | |
498 | #define SIZE_64GB 0x0000001000000000ULL\r | |
499 | #define SIZE_128GB 0x0000002000000000ULL\r | |
500 | #define SIZE_256GB 0x0000004000000000ULL\r | |
501 | #define SIZE_512GB 0x0000008000000000ULL\r | |
502 | #define SIZE_1TB 0x0000010000000000ULL\r | |
503 | #define SIZE_2TB 0x0000020000000000ULL\r | |
504 | #define SIZE_4TB 0x0000040000000000ULL\r | |
505 | #define SIZE_8TB 0x0000080000000000ULL\r | |
506 | #define SIZE_16TB 0x0000100000000000ULL\r | |
507 | #define SIZE_32TB 0x0000200000000000ULL\r | |
508 | #define SIZE_64TB 0x0000400000000000ULL\r | |
509 | #define SIZE_128TB 0x0000800000000000ULL\r | |
510 | #define SIZE_256TB 0x0001000000000000ULL\r | |
511 | #define SIZE_512TB 0x0002000000000000ULL\r | |
512 | #define SIZE_1PB 0x0004000000000000ULL\r | |
513 | #define SIZE_2PB 0x0008000000000000ULL\r | |
514 | #define SIZE_4PB 0x0010000000000000ULL\r | |
515 | #define SIZE_8PB 0x0020000000000000ULL\r | |
516 | #define SIZE_16PB 0x0040000000000000ULL\r | |
517 | #define SIZE_32PB 0x0080000000000000ULL\r | |
518 | #define SIZE_64PB 0x0100000000000000ULL\r | |
519 | #define SIZE_128PB 0x0200000000000000ULL\r | |
520 | #define SIZE_256PB 0x0400000000000000ULL\r | |
521 | #define SIZE_512PB 0x0800000000000000ULL\r | |
522 | #define SIZE_1EB 0x1000000000000000ULL\r | |
523 | #define SIZE_2EB 0x2000000000000000ULL\r | |
524 | #define SIZE_4EB 0x4000000000000000ULL\r | |
525 | #define SIZE_8EB 0x8000000000000000ULL\r | |
818ff8c2 | 526 | \r |
2e121e9a | 527 | #define BASE_1KB 0x00000400\r |
528 | #define BASE_2KB 0x00000800\r | |
529 | #define BASE_4KB 0x00001000\r | |
530 | #define BASE_8KB 0x00002000\r | |
531 | #define BASE_16KB 0x00004000\r | |
532 | #define BASE_32KB 0x00008000\r | |
533 | #define BASE_64KB 0x00010000\r | |
534 | #define BASE_128KB 0x00020000\r | |
535 | #define BASE_256KB 0x00040000\r | |
536 | #define BASE_512KB 0x00080000\r | |
537 | #define BASE_1MB 0x00100000\r | |
538 | #define BASE_2MB 0x00200000\r | |
539 | #define BASE_4MB 0x00400000\r | |
540 | #define BASE_8MB 0x00800000\r | |
541 | #define BASE_16MB 0x01000000\r | |
542 | #define BASE_32MB 0x02000000\r | |
543 | #define BASE_64MB 0x04000000\r | |
544 | #define BASE_128MB 0x08000000\r | |
545 | #define BASE_256MB 0x10000000\r | |
546 | #define BASE_512MB 0x20000000\r | |
547 | #define BASE_1GB 0x40000000\r | |
548 | #define BASE_2GB 0x80000000\r | |
549 | #define BASE_4GB 0x0000000100000000ULL\r | |
550 | #define BASE_8GB 0x0000000200000000ULL\r | |
551 | #define BASE_16GB 0x0000000400000000ULL\r | |
552 | #define BASE_32GB 0x0000000800000000ULL\r | |
553 | #define BASE_64GB 0x0000001000000000ULL\r | |
554 | #define BASE_128GB 0x0000002000000000ULL\r | |
555 | #define BASE_256GB 0x0000004000000000ULL\r | |
556 | #define BASE_512GB 0x0000008000000000ULL\r | |
557 | #define BASE_1TB 0x0000010000000000ULL\r | |
558 | #define BASE_2TB 0x0000020000000000ULL\r | |
559 | #define BASE_4TB 0x0000040000000000ULL\r | |
560 | #define BASE_8TB 0x0000080000000000ULL\r | |
561 | #define BASE_16TB 0x0000100000000000ULL\r | |
562 | #define BASE_32TB 0x0000200000000000ULL\r | |
563 | #define BASE_64TB 0x0000400000000000ULL\r | |
564 | #define BASE_128TB 0x0000800000000000ULL\r | |
565 | #define BASE_256TB 0x0001000000000000ULL\r | |
566 | #define BASE_512TB 0x0002000000000000ULL\r | |
567 | #define BASE_1PB 0x0004000000000000ULL\r | |
568 | #define BASE_2PB 0x0008000000000000ULL\r | |
569 | #define BASE_4PB 0x0010000000000000ULL\r | |
570 | #define BASE_8PB 0x0020000000000000ULL\r | |
571 | #define BASE_16PB 0x0040000000000000ULL\r | |
572 | #define BASE_32PB 0x0080000000000000ULL\r | |
573 | #define BASE_64PB 0x0100000000000000ULL\r | |
574 | #define BASE_128PB 0x0200000000000000ULL\r | |
575 | #define BASE_256PB 0x0400000000000000ULL\r | |
576 | #define BASE_512PB 0x0800000000000000ULL\r | |
577 | #define BASE_1EB 0x1000000000000000ULL\r | |
578 | #define BASE_2EB 0x2000000000000000ULL\r | |
579 | #define BASE_4EB 0x4000000000000000ULL\r | |
580 | #define BASE_8EB 0x8000000000000000ULL\r | |
581 | \r | |
959ccb23 | 582 | //\r |
e3e40c83 | 583 | // Support for variable argument lists in freestanding edk2 modules.\r |
818ff8c2 | 584 | //\r |
e3e40c83 Z |
585 | // For modules that use the ISO C library interfaces for variable\r |
586 | // argument lists, refer to "StdLib/Include/stdarg.h".\r | |
959ccb23 | 587 | //\r |
588 | // VA_LIST - typedef for argument list.\r | |
589 | // VA_START (VA_LIST Marker, argument before the ...) - Init Marker for use.\r | |
590 | // VA_END (VA_LIST Marker) - Clear Marker\r | |
e3e40c83 Z |
591 | // VA_ARG (VA_LIST Marker, var arg type) - Use Marker to get an argument from\r |
592 | // the ... list. You must know the type and pass it in this macro. Type\r | |
593 | // must be compatible with the type of the actual next argument (as promoted\r | |
594 | // according to the default argument promotions.)\r | |
265fa9fa | 595 | // VA_COPY (VA_LIST Dest, VA_LIST Start) - Initialize Dest as a copy of Start.\r |
959ccb23 | 596 | //\r |
e3e40c83 | 597 | // Example:\r |
959ccb23 | 598 | //\r |
599 | // UINTN\r | |
e3e40c83 | 600 | // EFIAPI\r |
959ccb23 | 601 | // ExampleVarArg (\r |
602 | // IN UINTN NumberOfArgs,\r | |
603 | // ...\r | |
604 | // )\r | |
605 | // {\r | |
606 | // VA_LIST Marker;\r | |
607 | // UINTN Index;\r | |
608 | // UINTN Result;\r | |
609 | //\r | |
610 | // //\r | |
611 | // // Initialize the Marker\r | |
612 | // //\r | |
613 | // VA_START (Marker, NumberOfArgs);\r | |
614 | // for (Index = 0, Result = 0; Index < NumberOfArgs; Index++) {\r | |
615 | // //\r | |
e3e40c83 | 616 | // // The ... list is a series of UINTN values, so sum them up.\r |
959ccb23 | 617 | // //\r |
618 | // Result += VA_ARG (Marker, UINTN);\r | |
619 | // }\r | |
620 | //\r | |
621 | // VA_END (Marker);\r | |
e3e40c83 | 622 | // return Result;\r |
959ccb23 | 623 | // }\r |
624 | //\r | |
e3e40c83 Z |
625 | // Notes:\r |
626 | // - Functions that call VA_START() / VA_END() must have a variable\r | |
627 | // argument list and must be declared EFIAPI.\r | |
628 | // - Functions that call VA_COPY() / VA_END() must be declared EFIAPI.\r | |
629 | // - Functions that only use VA_LIST and VA_ARG() need not be EFIAPI.\r | |
630 | //\r | |
0dcec411 | 631 | \r |
68167fed | 632 | /**\r |
633 | Return the size of argument that has been aligned to sizeof (UINTN).\r | |
634 | \r | |
af2dc6a7 | 635 | @param n The parameter size to be aligned.\r |
68167fed | 636 | \r |
af2dc6a7 | 637 | @return The aligned size.\r |
68167fed | 638 | **/\r |
639 | #define _INT_SIZE_OF(n) ((sizeof (n) + sizeof (UINTN) - 1) &~(sizeof (UINTN) - 1))\r | |
640 | \r | |
dda3a6ce | 641 | #if defined(__CC_ARM)\r |
642 | //\r | |
643 | // RVCT ARM variable argument list support.\r | |
644 | //\r | |
645 | \r | |
646 | ///\r | |
818ff8c2 | 647 | /// Variable used to traverse the list of arguments. This type can vary by\r |
648 | /// implementation and could be an array or structure.\r | |
dda3a6ce | 649 | ///\r |
650 | #ifdef __APCS_ADSABI\r | |
651 | typedef int *va_list[1];\r | |
652 | #define VA_LIST va_list\r | |
653 | #else\r | |
654 | typedef struct __va_list { void *__ap; } va_list;\r | |
655 | #define VA_LIST va_list\r | |
656 | #endif\r | |
657 | \r | |
658 | #define VA_START(Marker, Parameter) __va_start(Marker, Parameter)\r | |
659 | \r | |
660 | #define VA_ARG(Marker, TYPE) __va_arg(Marker, TYPE)\r | |
661 | \r | |
662 | #define VA_END(Marker) ((void)0)\r | |
663 | \r | |
7bbc624a | 664 | // For some ARM RVCT compilers, __va_copy is not defined\r |
665 | #ifndef __va_copy\r | |
666 | #define __va_copy(dest, src) ((void)((dest) = (src)))\r | |
667 | #endif\r | |
668 | \r | |
265fa9fa | 669 | #define VA_COPY(Dest, Start) __va_copy (Dest, Start)\r |
670 | \r | |
c41100f0 | 671 | #elif defined(_M_ARM) || defined(_M_ARM64)\r |
79195517 PB |
672 | //\r |
673 | // MSFT ARM variable argument list support.\r | |
79195517 PB |
674 | //\r |
675 | \r | |
676 | typedef char* VA_LIST;\r | |
677 | \r | |
c41100f0 PB |
678 | #define VA_START(Marker, Parameter) __va_start (&Marker, &Parameter, _INT_SIZE_OF (Parameter), __alignof(Parameter), &Parameter)\r |
679 | #define VA_ARG(Marker, TYPE) (*(TYPE *) ((Marker += _INT_SIZE_OF (TYPE) + ((-(INTN)Marker) & (sizeof(TYPE) - 1))) - _INT_SIZE_OF (TYPE)))\r | |
79195517 PB |
680 | #define VA_END(Marker) (Marker = (VA_LIST) 0)\r |
681 | #define VA_COPY(Dest, Start) ((void)((Dest) = (Start)))\r | |
682 | \r | |
17ab1ec5 | 683 | #elif defined(__GNUC__)\r |
48d5f9a5 SS |
684 | \r |
685 | #if defined(MDE_CPU_X64) && !defined(NO_MSABI_VA_FUNCS)\r | |
686 | //\r | |
687 | // X64 only. Use MS ABI version of GCC built-in macros for variable argument lists.\r | |
688 | //\r | |
689 | ///\r | |
690 | /// Both GCC and LLVM 3.8 for X64 support new variable argument intrinsics for Microsoft ABI\r | |
691 | ///\r | |
692 | \r | |
693 | ///\r | |
694 | /// Variable used to traverse the list of arguments. This type can vary by\r | |
695 | /// implementation and could be an array or structure.\r | |
696 | ///\r | |
697 | typedef __builtin_ms_va_list VA_LIST;\r | |
698 | \r | |
699 | #define VA_START(Marker, Parameter) __builtin_ms_va_start (Marker, Parameter)\r | |
700 | \r | |
701 | #define VA_ARG(Marker, TYPE) ((sizeof (TYPE) < sizeof (UINTN)) ? (TYPE)(__builtin_va_arg (Marker, UINTN)) : (TYPE)(__builtin_va_arg (Marker, TYPE)))\r | |
702 | \r | |
703 | #define VA_END(Marker) __builtin_ms_va_end (Marker)\r | |
704 | \r | |
705 | #define VA_COPY(Dest, Start) __builtin_ms_va_copy (Dest, Start)\r | |
706 | \r | |
707 | #else\r | |
130a2eec | 708 | //\r |
1a2f870c | 709 | // Use GCC built-in macros for variable argument lists.\r |
130a2eec | 710 | //\r |
dda3a6ce | 711 | \r |
712 | ///\r | |
818ff8c2 | 713 | /// Variable used to traverse the list of arguments. This type can vary by\r |
714 | /// implementation and could be an array or structure.\r | |
dda3a6ce | 715 | ///\r |
130a2eec | 716 | typedef __builtin_va_list VA_LIST;\r |
717 | \r | |
6ed623e4 | 718 | #define VA_START(Marker, Parameter) __builtin_va_start (Marker, Parameter)\r |
959ccb23 | 719 | \r |
6ed623e4 | 720 | #define VA_ARG(Marker, TYPE) ((sizeof (TYPE) < sizeof (UINTN)) ? (TYPE)(__builtin_va_arg (Marker, UINTN)) : (TYPE)(__builtin_va_arg (Marker, TYPE)))\r |
130a2eec | 721 | \r |
6ed623e4 | 722 | #define VA_END(Marker) __builtin_va_end (Marker)\r |
130a2eec | 723 | \r |
265fa9fa | 724 | #define VA_COPY(Dest, Start) __builtin_va_copy (Dest, Start)\r |
725 | \r | |
48d5f9a5 SS |
726 | #endif\r |
727 | \r | |
130a2eec | 728 | #else\r |
f4ec40ab | 729 | ///\r |
818ff8c2 | 730 | /// Variable used to traverse the list of arguments. This type can vary by\r |
731 | /// implementation and could be an array or structure.\r | |
f4ec40ab | 732 | ///\r |
959ccb23 | 733 | typedef CHAR8 *VA_LIST;\r |
959ccb23 | 734 | \r |
3963c4bf | 735 | /**\r |
818ff8c2 | 736 | Retrieves a pointer to the beginning of a variable argument list, based on\r |
737 | the name of the parameter that immediately precedes the variable argument list.\r | |
3963c4bf | 738 | \r |
818ff8c2 | 739 | This function initializes Marker to point to the beginning of the variable\r |
740 | argument list that immediately follows Parameter. The method for computing the\r | |
741 | pointer to the next argument in the argument list is CPU-specific following the\r | |
af2dc6a7 | 742 | EFIAPI ABI.\r |
3963c4bf | 743 | \r |
af2dc6a7 | 744 | @param Marker The VA_LIST used to traverse the list of arguments.\r |
818ff8c2 | 745 | @param Parameter The name of the parameter that immediately precedes\r |
3963c4bf | 746 | the variable argument list.\r |
818ff8c2 | 747 | \r |
3963c4bf | 748 | @return A pointer to the beginning of a variable argument list.\r |
749 | \r | |
750 | **/\r | |
a58b9d96 | 751 | #define VA_START(Marker, Parameter) (Marker = (VA_LIST) ((UINTN) & (Parameter) + _INT_SIZE_OF (Parameter)))\r |
3963c4bf | 752 | \r |
753 | /**\r | |
818ff8c2 | 754 | Returns an argument of a specified type from a variable argument list and updates\r |
755 | the pointer to the variable argument list to point to the next argument.\r | |
3963c4bf | 756 | \r |
818ff8c2 | 757 | This function returns an argument of the type specified by TYPE from the beginning\r |
758 | of the variable argument list specified by Marker. Marker is then updated to point\r | |
759 | to the next argument in the variable argument list. The method for computing the\r | |
af2dc6a7 | 760 | pointer to the next argument in the argument list is CPU-specific following the EFIAPI ABI.\r |
3963c4bf | 761 | \r |
dda3a6ce | 762 | @param Marker VA_LIST used to traverse the list of arguments.\r |
818ff8c2 | 763 | @param TYPE The type of argument to retrieve from the beginning\r |
3963c4bf | 764 | of the variable argument list.\r |
818ff8c2 | 765 | \r |
3963c4bf | 766 | @return An argument of the type specified by TYPE.\r |
767 | \r | |
768 | **/\r | |
769 | #define VA_ARG(Marker, TYPE) (*(TYPE *) ((Marker += _INT_SIZE_OF (TYPE)) - _INT_SIZE_OF (TYPE)))\r | |
770 | \r | |
771 | /**\r | |
772 | Terminates the use of a variable argument list.\r | |
773 | \r | |
818ff8c2 | 774 | This function initializes Marker so it can no longer be used with VA_ARG().\r |
775 | After this macro is used, the only way to access the variable argument list is\r | |
3963c4bf | 776 | by using VA_START() again.\r |
777 | \r | |
dda3a6ce | 778 | @param Marker VA_LIST used to traverse the list of arguments.\r |
818ff8c2 | 779 | \r |
3963c4bf | 780 | **/\r |
781 | #define VA_END(Marker) (Marker = (VA_LIST) 0)\r | |
782 | \r | |
265fa9fa | 783 | /**\r |
784 | Initializes a VA_LIST as a copy of an existing VA_LIST.\r | |
785 | \r | |
786 | This macro initializes Dest as a copy of Start, as if the VA_START macro had been applied to Dest\r | |
787 | followed by the same sequence of uses of the VA_ARG macro as had previously been used to reach\r | |
788 | the present state of Start. \r | |
789 | \r | |
790 | @param Dest VA_LIST used to traverse the list of arguments.\r | |
791 | @param Start VA_LIST used to traverse the list of arguments.\r | |
792 | \r | |
793 | **/\r | |
794 | #define VA_COPY(Dest, Start) ((void)((Dest) = (Start)))\r | |
795 | \r | |
130a2eec | 796 | #endif\r |
797 | \r | |
68167fed | 798 | ///\r |
799 | /// Pointer to the start of a variable argument list stored in a memory buffer. Same as UINT8 *.\r | |
800 | ///\r | |
801 | typedef UINTN *BASE_LIST;\r | |
802 | \r | |
2229029a | 803 | /**\r |
804 | Returns the size of a data type in sizeof(UINTN) units rounded up to the nearest UINTN boundary.\r | |
805 | \r | |
806 | @param TYPE The date type to determine the size of.\r | |
807 | \r | |
808 | @return The size of TYPE in sizeof (UINTN) units rounded up to the nearest UINTN boundary.\r | |
809 | **/\r | |
810 | #define _BASE_INT_SIZE_OF(TYPE) ((sizeof (TYPE) + sizeof (UINTN) - 1) / sizeof (UINTN))\r | |
811 | \r | |
68167fed | 812 | /**\r |
818ff8c2 | 813 | Returns an argument of a specified type from a variable argument list and updates\r |
814 | the pointer to the variable argument list to point to the next argument.\r | |
68167fed | 815 | \r |
818ff8c2 | 816 | This function returns an argument of the type specified by TYPE from the beginning\r |
817 | of the variable argument list specified by Marker. Marker is then updated to point\r | |
818 | to the next argument in the variable argument list. The method for computing the\r | |
68167fed | 819 | pointer to the next argument in the argument list is CPU specific following the EFIAPI ABI.\r |
820 | \r | |
af2dc6a7 | 821 | @param Marker The pointer to the beginning of a variable argument list.\r |
818ff8c2 | 822 | @param TYPE The type of argument to retrieve from the beginning\r |
68167fed | 823 | of the variable argument list.\r |
818ff8c2 | 824 | \r |
68167fed | 825 | @return An argument of the type specified by TYPE.\r |
826 | \r | |
827 | **/\r | |
2229029a | 828 | #define BASE_ARG(Marker, TYPE) (*(TYPE *) ((Marker += _BASE_INT_SIZE_OF (TYPE)) - _BASE_INT_SIZE_OF (TYPE)))\r |
68167fed | 829 | \r |
3963c4bf | 830 | /**\r |
818ff8c2 | 831 | The macro that returns the byte offset of a field in a data structure.\r |
3963c4bf | 832 | \r |
818ff8c2 | 833 | This function returns the offset, in bytes, of field specified by Field from the\r |
834 | beginning of the data structure specified by TYPE. If TYPE does not contain Field,\r | |
835 | the module will not compile.\r | |
3963c4bf | 836 | \r |
818ff8c2 | 837 | @param TYPE The name of the data structure that contains the field specified by Field.\r |
3963c4bf | 838 | @param Field The name of the field in the data structure.\r |
818ff8c2 | 839 | \r |
3963c4bf | 840 | @return Offset, in bytes, of field.\r |
818ff8c2 | 841 | \r |
3963c4bf | 842 | **/\r |
818ff8c2 | 843 | #ifdef __GNUC__\r |
844 | #if __GNUC__ >= 4\r | |
845 | #define OFFSET_OF(TYPE, Field) ((UINTN) __builtin_offsetof(TYPE, Field))\r | |
846 | #endif\r | |
847 | #endif\r | |
848 | \r | |
849 | #ifndef OFFSET_OF\r | |
959ccb23 | 850 | #define OFFSET_OF(TYPE, Field) ((UINTN) &(((TYPE *)0)->Field))\r |
818ff8c2 | 851 | #endif\r |
959ccb23 | 852 | \r |
3963c4bf | 853 | /**\r |
818ff8c2 | 854 | Macro that returns a pointer to the data structure that contains a specified field of\r |
855 | that data structure. This is a lightweight method to hide information by placing a\r | |
856 | public data structure inside a larger private data structure and using a pointer to\r | |
3963c4bf | 857 | the public data structure to retrieve a pointer to the private data structure.\r |
858 | \r | |
818ff8c2 | 859 | This function computes the offset, in bytes, of field specified by Field from the beginning\r |
860 | of the data structure specified by TYPE. This offset is subtracted from Record, and is\r | |
861 | used to return a pointer to a data structure of the type specified by TYPE. If the data type\r | |
862 | specified by TYPE does not contain the field specified by Field, then the module will not compile.\r | |
863 | \r | |
864 | @param Record Pointer to the field specified by Field within a data structure of type TYPE.\r | |
865 | @param TYPE The name of the data structure type to return. This data structure must\r | |
866 | contain the field specified by Field.\r | |
3963c4bf | 867 | @param Field The name of the field in the data structure specified by TYPE to which Record points.\r |
818ff8c2 | 868 | \r |
3963c4bf | 869 | @return A pointer to the structure from one of it's elements.\r |
818ff8c2 | 870 | \r |
3963c4bf | 871 | **/\r |
22ce9dc5 | 872 | #define BASE_CR(Record, TYPE, Field) ((TYPE *) ((CHAR8 *) (Record) - (CHAR8 *) &(((TYPE *) 0)->Field)))\r |
959ccb23 | 873 | \r |
3963c4bf | 874 | /**\r |
818ff8c2 | 875 | Rounds a value up to the next boundary using a specified alignment.\r |
3963c4bf | 876 | \r |
818ff8c2 | 877 | This function rounds Value up to the next boundary using the specified Alignment.\r |
878 | This aligned value is returned.\r | |
3963c4bf | 879 | \r |
880 | @param Value The value to round up.\r | |
881 | @param Alignment The alignment boundary used to return the aligned value.\r | |
818ff8c2 | 882 | \r |
3963c4bf | 883 | @return A value up to the next boundary.\r |
818ff8c2 | 884 | \r |
3963c4bf | 885 | **/\r |
3fef0f51 | 886 | #define ALIGN_VALUE(Value, Alignment) ((Value) + (((Alignment) - (Value)) & ((Alignment) - 1)))\r |
887 | \r | |
3963c4bf | 888 | /**\r |
818ff8c2 | 889 | Adjust a pointer by adding the minimum offset required for it to be aligned on\r |
890 | a specified alignment boundary.\r | |
3963c4bf | 891 | \r |
818ff8c2 | 892 | This function rounds the pointer specified by Pointer to the next alignment boundary\r |
893 | specified by Alignment. The pointer to the aligned address is returned.\r | |
3963c4bf | 894 | \r |
f754f721 | 895 | @param Pointer The pointer to round up.\r |
3963c4bf | 896 | @param Alignment The alignment boundary to use to return an aligned pointer.\r |
818ff8c2 | 897 | \r |
3963c4bf | 898 | @return Pointer to the aligned address.\r |
818ff8c2 | 899 | \r |
3963c4bf | 900 | **/\r |
3fef0f51 | 901 | #define ALIGN_POINTER(Pointer, Alignment) ((VOID *) (ALIGN_VALUE ((UINTN)(Pointer), (Alignment))))\r |
959ccb23 | 902 | \r |
3963c4bf | 903 | /**\r |
818ff8c2 | 904 | Rounds a value up to the next natural boundary for the current CPU.\r |
905 | This is 4-bytes for 32-bit CPUs and 8-bytes for 64-bit CPUs.\r | |
3963c4bf | 906 | \r |
818ff8c2 | 907 | This function rounds the value specified by Value up to the next natural boundary for the\r |
908 | current CPU. This rounded value is returned.\r | |
3963c4bf | 909 | \r |
910 | @param Value The value to round up.\r | |
911 | \r | |
912 | @return Rounded value specified by Value.\r | |
818ff8c2 | 913 | \r |
3963c4bf | 914 | **/\r |
3fef0f51 | 915 | #define ALIGN_VARIABLE(Value) ALIGN_VALUE ((Value), sizeof (UINTN))\r |
818ff8c2 | 916 | \r |
959ccb23 | 917 | \r |
3963c4bf | 918 | /**\r |
818ff8c2 | 919 | Return the maximum of two operands.\r |
3963c4bf | 920 | \r |
818ff8c2 | 921 | This macro returns the maximum of two operand specified by a and b.\r |
3963c4bf | 922 | Both a and b must be the same numerical types, signed or unsigned.\r |
923 | \r | |
3963c4bf | 924 | @param a The first operand with any numerical type.\r |
818ff8c2 | 925 | @param b The second operand. Can be any numerical type as long as is\r |
a89fa50c | 926 | the same type as a.\r |
818ff8c2 | 927 | \r |
3963c4bf | 928 | @return Maximum of two operands.\r |
818ff8c2 | 929 | \r |
3963c4bf | 930 | **/\r |
959ccb23 | 931 | #define MAX(a, b) \\r |
932 | (((a) > (b)) ? (a) : (b))\r | |
933 | \r | |
3963c4bf | 934 | /**\r |
818ff8c2 | 935 | Return the minimum of two operands.\r |
3963c4bf | 936 | \r |
818ff8c2 | 937 | This macro returns the minimal of two operand specified by a and b.\r |
3963c4bf | 938 | Both a and b must be the same numerical types, signed or unsigned.\r |
939 | \r | |
3963c4bf | 940 | @param a The first operand with any numerical type.\r |
941 | @param b The second operand. It should be the same any numerical type with a.\r | |
818ff8c2 | 942 | \r |
3963c4bf | 943 | @return Minimum of two operands.\r |
818ff8c2 | 944 | \r |
3963c4bf | 945 | **/\r |
959ccb23 | 946 | #define MIN(a, b) \\r |
947 | (((a) < (b)) ? (a) : (b))\r | |
948 | \r | |
8b157410 | 949 | /**\r |
950 | Return the absolute value of a signed operand.\r | |
951 | \r | |
952 | This macro returns the absolute value of the signed operand specified by a.\r | |
953 | \r | |
954 | @param a The signed operand.\r | |
955 | \r | |
956 | @return The absolute value of the signed operand.\r | |
957 | \r | |
958 | **/\r | |
959 | #define ABS(a) \\r | |
960 | (((a) < 0) ? (-(a)) : (a))\r | |
961 | \r | |
959ccb23 | 962 | //\r |
f4ec40ab | 963 | // Status codes common to all execution phases\r |
959ccb23 | 964 | //\r |
6f906c39 | 965 | typedef UINTN RETURN_STATUS;\r |
959ccb23 | 966 | \r |
f4ec40ab | 967 | /**\r |
818ff8c2 | 968 | Produces a RETURN_STATUS code with the highest bit set.\r |
959ccb23 | 969 | \r |
818ff8c2 | 970 | @param StatusCode The status code value to convert into a warning code.\r |
f4ec40ab | 971 | StatusCode must be in the range 0x00000000..0x7FFFFFFF.\r |
972 | \r | |
973 | @return The value specified by StatusCode with the highest bit set.\r | |
974 | \r | |
975 | **/\r | |
262ffea8 | 976 | #define ENCODE_ERROR(StatusCode) ((RETURN_STATUS)(MAX_BIT | (StatusCode)))\r |
959ccb23 | 977 | \r |
f4ec40ab | 978 | /**\r |
818ff8c2 | 979 | Produces a RETURN_STATUS code with the highest bit clear.\r |
f4ec40ab | 980 | \r |
818ff8c2 | 981 | @param StatusCode The status code value to convert into a warning code.\r |
f4ec40ab | 982 | StatusCode must be in the range 0x00000000..0x7FFFFFFF.\r |
983 | \r | |
984 | @return The value specified by StatusCode with the highest bit clear.\r | |
985 | \r | |
986 | **/\r | |
262ffea8 | 987 | #define ENCODE_WARNING(StatusCode) ((RETURN_STATUS)(StatusCode))\r |
f4ec40ab | 988 | \r |
989 | /**\r | |
818ff8c2 | 990 | Returns TRUE if a specified RETURN_STATUS code is an error code.\r |
991 | \r | |
992 | This function returns TRUE if StatusCode has the high bit set. Otherwise, FALSE is returned.\r | |
f4ec40ab | 993 | \r |
40731047 | 994 | @param StatusCode The status code value to evaluate.\r |
f4ec40ab | 995 | \r |
996 | @retval TRUE The high bit of StatusCode is set.\r | |
997 | @retval FALSE The high bit of StatusCode is clear.\r | |
998 | \r | |
999 | **/\r | |
6f906c39 | 1000 | #define RETURN_ERROR(StatusCode) (((INTN)(RETURN_STATUS)(StatusCode)) < 0)\r |
f4ec40ab | 1001 | \r |
1002 | ///\r | |
1003 | /// The operation completed successfully.\r | |
1004 | ///\r | |
959ccb23 | 1005 | #define RETURN_SUCCESS 0\r |
f4ec40ab | 1006 | \r |
1007 | ///\r | |
1008 | /// The image failed to load.\r | |
1009 | ///\r | |
959ccb23 | 1010 | #define RETURN_LOAD_ERROR ENCODE_ERROR (1)\r |
f4ec40ab | 1011 | \r |
1012 | ///\r | |
1013 | /// The parameter was incorrect.\r | |
1014 | ///\r | |
959ccb23 | 1015 | #define RETURN_INVALID_PARAMETER ENCODE_ERROR (2)\r |
f4ec40ab | 1016 | \r |
1017 | ///\r | |
1018 | /// The operation is not supported.\r | |
1019 | ///\r | |
959ccb23 | 1020 | #define RETURN_UNSUPPORTED ENCODE_ERROR (3)\r |
f4ec40ab | 1021 | \r |
1022 | ///\r | |
1023 | /// The buffer was not the proper size for the request.\r | |
1024 | ///\r | |
959ccb23 | 1025 | #define RETURN_BAD_BUFFER_SIZE ENCODE_ERROR (4)\r |
f4ec40ab | 1026 | \r |
1027 | ///\r | |
1028 | /// The buffer was not large enough to hold the requested data.\r | |
1029 | /// The required buffer size is returned in the appropriate\r | |
1030 | /// parameter when this error occurs.\r | |
1031 | ///\r | |
959ccb23 | 1032 | #define RETURN_BUFFER_TOO_SMALL ENCODE_ERROR (5)\r |
f4ec40ab | 1033 | \r |
1034 | ///\r | |
80619162 | 1035 | /// There is no data pending upon return.\r |
f4ec40ab | 1036 | ///\r |
959ccb23 | 1037 | #define RETURN_NOT_READY ENCODE_ERROR (6)\r |
f4ec40ab | 1038 | \r |
1039 | ///\r | |
1040 | /// The physical device reported an error while attempting the\r | |
1041 | /// operation.\r | |
1042 | ///\r | |
959ccb23 | 1043 | #define RETURN_DEVICE_ERROR ENCODE_ERROR (7)\r |
f4ec40ab | 1044 | \r |
1045 | ///\r | |
1046 | /// The device can not be written to.\r | |
1047 | ///\r | |
959ccb23 | 1048 | #define RETURN_WRITE_PROTECTED ENCODE_ERROR (8)\r |
f4ec40ab | 1049 | \r |
1050 | ///\r | |
1051 | /// The resource has run out.\r | |
1052 | ///\r | |
959ccb23 | 1053 | #define RETURN_OUT_OF_RESOURCES ENCODE_ERROR (9)\r |
f4ec40ab | 1054 | \r |
1055 | ///\r | |
818ff8c2 | 1056 | /// An inconsistency was detected on the file system causing the\r |
f4ec40ab | 1057 | /// operation to fail.\r |
1058 | ///\r | |
959ccb23 | 1059 | #define RETURN_VOLUME_CORRUPTED ENCODE_ERROR (10)\r |
f4ec40ab | 1060 | \r |
1061 | ///\r | |
1062 | /// There is no more space on the file system.\r | |
1063 | ///\r | |
959ccb23 | 1064 | #define RETURN_VOLUME_FULL ENCODE_ERROR (11)\r |
f4ec40ab | 1065 | \r |
1066 | ///\r | |
818ff8c2 | 1067 | /// The device does not contain any medium to perform the\r |
f4ec40ab | 1068 | /// operation.\r |
1069 | ///\r | |
959ccb23 | 1070 | #define RETURN_NO_MEDIA ENCODE_ERROR (12)\r |
f4ec40ab | 1071 | \r |
1072 | ///\r | |
1073 | /// The medium in the device has changed since the last\r | |
1074 | /// access.\r | |
1075 | ///\r | |
959ccb23 | 1076 | #define RETURN_MEDIA_CHANGED ENCODE_ERROR (13)\r |
f4ec40ab | 1077 | \r |
1078 | ///\r | |
1079 | /// The item was not found.\r | |
1080 | ///\r | |
959ccb23 | 1081 | #define RETURN_NOT_FOUND ENCODE_ERROR (14)\r |
f4ec40ab | 1082 | \r |
1083 | ///\r | |
1084 | /// Access was denied.\r | |
1085 | ///\r | |
959ccb23 | 1086 | #define RETURN_ACCESS_DENIED ENCODE_ERROR (15)\r |
f4ec40ab | 1087 | \r |
1088 | ///\r | |
1089 | /// The server was not found or did not respond to the request.\r | |
1090 | ///\r | |
959ccb23 | 1091 | #define RETURN_NO_RESPONSE ENCODE_ERROR (16)\r |
f4ec40ab | 1092 | \r |
1093 | ///\r | |
1094 | /// A mapping to the device does not exist.\r | |
1095 | ///\r | |
959ccb23 | 1096 | #define RETURN_NO_MAPPING ENCODE_ERROR (17)\r |
f4ec40ab | 1097 | \r |
1098 | ///\r | |
1099 | /// A timeout time expired.\r | |
1100 | ///\r | |
959ccb23 | 1101 | #define RETURN_TIMEOUT ENCODE_ERROR (18)\r |
f4ec40ab | 1102 | \r |
1103 | ///\r | |
1104 | /// The protocol has not been started.\r | |
1105 | ///\r | |
959ccb23 | 1106 | #define RETURN_NOT_STARTED ENCODE_ERROR (19)\r |
f4ec40ab | 1107 | \r |
1108 | ///\r | |
1109 | /// The protocol has already been started.\r | |
1110 | ///\r | |
959ccb23 | 1111 | #define RETURN_ALREADY_STARTED ENCODE_ERROR (20)\r |
f4ec40ab | 1112 | \r |
1113 | ///\r | |
1114 | /// The operation was aborted.\r | |
1115 | ///\r | |
959ccb23 | 1116 | #define RETURN_ABORTED ENCODE_ERROR (21)\r |
f4ec40ab | 1117 | \r |
1118 | ///\r | |
727501bb | 1119 | /// An ICMP error occurred during the network operation.\r |
f4ec40ab | 1120 | ///\r |
959ccb23 | 1121 | #define RETURN_ICMP_ERROR ENCODE_ERROR (22)\r |
f4ec40ab | 1122 | \r |
1123 | ///\r | |
727501bb | 1124 | /// A TFTP error occurred during the network operation.\r |
f4ec40ab | 1125 | ///\r |
959ccb23 | 1126 | #define RETURN_TFTP_ERROR ENCODE_ERROR (23)\r |
f4ec40ab | 1127 | \r |
1128 | ///\r | |
727501bb | 1129 | /// A protocol error occurred during the network operation.\r |
f4ec40ab | 1130 | ///\r |
959ccb23 | 1131 | #define RETURN_PROTOCOL_ERROR ENCODE_ERROR (24)\r |
f4ec40ab | 1132 | \r |
1133 | ///\r | |
1134 | /// A function encountered an internal version that was\r | |
727501bb | 1135 | /// incompatible with a version requested by the caller.\r |
f4ec40ab | 1136 | ///\r |
959ccb23 | 1137 | #define RETURN_INCOMPATIBLE_VERSION ENCODE_ERROR (25)\r |
f4ec40ab | 1138 | \r |
1139 | ///\r | |
1140 | /// The function was not performed due to a security violation.\r | |
1141 | ///\r | |
959ccb23 | 1142 | #define RETURN_SECURITY_VIOLATION ENCODE_ERROR (26)\r |
f4ec40ab | 1143 | \r |
1144 | ///\r | |
1145 | /// A CRC error was detected.\r | |
1146 | ///\r | |
959ccb23 | 1147 | #define RETURN_CRC_ERROR ENCODE_ERROR (27)\r |
f4ec40ab | 1148 | \r |
1149 | ///\r | |
af2dc6a7 | 1150 | /// The beginning or end of media was reached.\r |
f4ec40ab | 1151 | ///\r |
959ccb23 | 1152 | #define RETURN_END_OF_MEDIA ENCODE_ERROR (28)\r |
f4ec40ab | 1153 | \r |
1154 | ///\r | |
1155 | /// The end of the file was reached.\r | |
1156 | ///\r | |
959ccb23 | 1157 | #define RETURN_END_OF_FILE ENCODE_ERROR (31)\r |
f4ec40ab | 1158 | \r |
1159 | ///\r | |
1160 | /// The language specified was invalid.\r | |
1161 | ///\r | |
54cf8780 | 1162 | #define RETURN_INVALID_LANGUAGE ENCODE_ERROR (32)\r |
1163 | \r | |
76336e4e SZ |
1164 | ///\r |
1165 | /// The security status of the data is unknown or compromised\r | |
1166 | /// and the data must be updated or replaced to restore a valid\r | |
1167 | /// security status.\r | |
1168 | ///\r | |
1169 | #define RETURN_COMPROMISED_DATA ENCODE_ERROR (33)\r | |
959ccb23 | 1170 | \r |
10a3840f ZL |
1171 | ///\r |
1172 | /// A HTTP error occurred during the network operation.\r | |
1173 | ///\r | |
1174 | #define RETURN_HTTP_ERROR ENCODE_ERROR (35)\r | |
1175 | \r | |
f4ec40ab | 1176 | ///\r |
fbf926ad | 1177 | /// The string contained one or more characters that\r |
f4ec40ab | 1178 | /// the device could not render and were skipped.\r |
1179 | ///\r | |
959ccb23 | 1180 | #define RETURN_WARN_UNKNOWN_GLYPH ENCODE_WARNING (1)\r |
f4ec40ab | 1181 | \r |
1182 | ///\r | |
1183 | /// The handle was closed, but the file was not deleted.\r | |
1184 | ///\r | |
959ccb23 | 1185 | #define RETURN_WARN_DELETE_FAILURE ENCODE_WARNING (2)\r |
f4ec40ab | 1186 | \r |
1187 | ///\r | |
1188 | /// The handle was closed, but the data to the file was not\r | |
1189 | /// flushed properly.\r | |
1190 | ///\r | |
959ccb23 | 1191 | #define RETURN_WARN_WRITE_FAILURE ENCODE_WARNING (3)\r |
f4ec40ab | 1192 | \r |
1193 | ///\r | |
818ff8c2 | 1194 | /// The resulting buffer was too small, and the data was\r |
f4ec40ab | 1195 | /// truncated to the buffer size.\r |
1196 | ///\r | |
959ccb23 | 1197 | #define RETURN_WARN_BUFFER_TOO_SMALL ENCODE_WARNING (4)\r |
1198 | \r | |
76336e4e SZ |
1199 | ///\r |
1200 | /// The data has not been updated within the timeframe set by\r | |
1201 | /// local policy for this type of data.\r | |
1202 | ///\r | |
1203 | #define RETURN_WARN_STALE_DATA ENCODE_WARNING (5)\r | |
1204 | \r | |
fed5f447 FS |
1205 | ///\r |
1206 | /// The resulting buffer contains UEFI-compliant file system.\r | |
1207 | ///\r | |
1208 | #define RETURN_WARN_FILE_SYSTEM ENCODE_WARNING (6)\r | |
1209 | \r | |
1210 | \r | |
a7cc3d26 | 1211 | /**\r |
1212 | Returns a 16-bit signature built from 2 ASCII characters.\r | |
818ff8c2 | 1213 | \r |
1214 | This macro returns a 16-bit value built from the two ASCII characters specified\r | |
3963c4bf | 1215 | by A and B.\r |
818ff8c2 | 1216 | \r |
ee6c452c | 1217 | @param A The first ASCII character.\r |
1218 | @param B The second ASCII character.\r | |
a7cc3d26 | 1219 | \r |
1220 | @return A 16-bit value built from the two ASCII characters specified by A and B.\r | |
1221 | \r | |
1222 | **/\r | |
13c31065 | 1223 | #define SIGNATURE_16(A, B) ((A) | (B << 8))\r |
a7cc3d26 | 1224 | \r |
1225 | /**\r | |
1226 | Returns a 32-bit signature built from 4 ASCII characters.\r | |
818ff8c2 | 1227 | \r |
1228 | This macro returns a 32-bit value built from the four ASCII characters specified\r | |
3963c4bf | 1229 | by A, B, C, and D.\r |
818ff8c2 | 1230 | \r |
ee6c452c | 1231 | @param A The first ASCII character.\r |
1232 | @param B The second ASCII character.\r | |
1233 | @param C The third ASCII character.\r | |
1234 | @param D The fourth ASCII character.\r | |
a7cc3d26 | 1235 | \r |
1236 | @return A 32-bit value built from the two ASCII characters specified by A, B,\r | |
1237 | C and D.\r | |
1238 | \r | |
1239 | **/\r | |
13c31065 | 1240 | #define SIGNATURE_32(A, B, C, D) (SIGNATURE_16 (A, B) | (SIGNATURE_16 (C, D) << 16))\r |
a7cc3d26 | 1241 | \r |
1242 | /**\r | |
1243 | Returns a 64-bit signature built from 8 ASCII characters.\r | |
818ff8c2 | 1244 | \r |
1245 | This macro returns a 64-bit value built from the eight ASCII characters specified\r | |
3963c4bf | 1246 | by A, B, C, D, E, F, G,and H.\r |
818ff8c2 | 1247 | \r |
ee6c452c | 1248 | @param A The first ASCII character.\r |
1249 | @param B The second ASCII character.\r | |
1250 | @param C The third ASCII character.\r | |
1251 | @param D The fourth ASCII character.\r | |
1252 | @param E The fifth ASCII character.\r | |
1253 | @param F The sixth ASCII character.\r | |
1254 | @param G The seventh ASCII character.\r | |
1255 | @param H The eighth ASCII character.\r | |
a7cc3d26 | 1256 | \r |
1257 | @return A 64-bit value built from the two ASCII characters specified by A, B,\r | |
1258 | C, D, E, F, G and H.\r | |
1259 | \r | |
1260 | **/\r | |
13c31065 | 1261 | #define SIGNATURE_64(A, B, C, D, E, F, G, H) \\r |
1262 | (SIGNATURE_32 (A, B, C, D) | ((UINT64) (SIGNATURE_32 (E, F, G, H)) << 32))\r | |
1263 | \r | |
62ec4a5e | 1264 | #if defined(_MSC_EXTENSIONS) && !defined (__INTEL_COMPILER) && !defined (MDE_CPU_EBC)\r |
ed6da357 | 1265 | void * _ReturnAddress(void);\r |
dad83a8c | 1266 | #pragma intrinsic(_ReturnAddress)\r |
1db55d6a | 1267 | /**\r |
2a3a91eb | 1268 | Get the return address of the calling function.\r |
1db55d6a SZ |
1269 | \r |
1270 | Based on intrinsic function _ReturnAddress that provides the address of\r | |
1271 | the instruction in the calling function that will be executed after\r | |
1272 | control returns to the caller.\r | |
1273 | \r | |
1274 | @param L Return Level.\r | |
1275 | \r | |
2a3a91eb | 1276 | @return The return address of the calling function or 0 if L != 0.\r |
1db55d6a SZ |
1277 | \r |
1278 | **/\r | |
dad83a8c SZ |
1279 | #define RETURN_ADDRESS(L) ((L == 0) ? _ReturnAddress() : (VOID *) 0)\r |
1280 | #elif defined(__GNUC__)\r | |
dad83a8c | 1281 | void * __builtin_return_address (unsigned int level);\r |
1db55d6a | 1282 | /**\r |
2a3a91eb | 1283 | Get the return address of the calling function.\r |
1db55d6a SZ |
1284 | \r |
1285 | Based on built-in Function __builtin_return_address that returns\r | |
1286 | the return address of the current function, or of one of its callers.\r | |
1287 | \r | |
1288 | @param L Return Level.\r | |
1289 | \r | |
2a3a91eb | 1290 | @return The return address of the calling function.\r |
1db55d6a SZ |
1291 | \r |
1292 | **/\r | |
dad83a8c SZ |
1293 | #define RETURN_ADDRESS(L) __builtin_return_address (L)\r |
1294 | #else\r | |
1db55d6a | 1295 | /**\r |
2a3a91eb | 1296 | Get the return address of the calling function.\r |
1db55d6a SZ |
1297 | \r |
1298 | @param L Return Level.\r | |
1299 | \r | |
1300 | @return 0 as compilers don't support this feature.\r | |
1301 | \r | |
1302 | **/\r | |
dad83a8c SZ |
1303 | #define RETURN_ADDRESS(L) ((VOID *) 0)\r |
1304 | #endif\r | |
1305 | \r | |
c3ead528 LE |
1306 | /**\r |
1307 | Return the number of elements in an array.\r | |
1308 | \r | |
1309 | @param Array An object of array type. Array is only used as an argument to\r | |
1310 | the sizeof operator, therefore Array is never evaluated. The\r | |
1311 | caller is responsible for ensuring that Array's type is not\r | |
1312 | incomplete; that is, Array must have known constant size.\r | |
1313 | \r | |
1314 | @return The number of elements in Array. The result has type UINTN.\r | |
1315 | \r | |
1316 | **/\r | |
1317 | #define ARRAY_SIZE(Array) (sizeof (Array) / sizeof ((Array)[0]))\r | |
1318 | \r | |
959ccb23 | 1319 | #endif\r |
1320 | \r |