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