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