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