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