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