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