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