2 Root include file for Mde Package Base type modules
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.
9 Copyright (c) 2006 - 2016, 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.
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.
26 // Include processor specific binding
28 #include <ProcessorBind.h>
30 #if defined(_MSC_EXTENSIONS)
32 // Disable warning when last field of data structure is a zero sized array.
34 #pragma warning ( disable : 4200 )
38 Verifies the storage size of a given data type.
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.
44 @param TYPE The date type to determine the size of.
45 @param Size The expected size for the TYPE.
48 #define VERIFY_SIZE_OF(TYPE, Size) extern UINT8 _VerifySizeof##TYPE[(sizeof(TYPE) == (Size)) / (sizeof(TYPE) == (Size))]
51 // Verify that ProcessorBind.h produced UEFI Data Types that are compliant with
52 // Section 2.3.1 of the UEFI 2.3 Specification.
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);
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
74 __VerifyUint8EnumValue
= 0xff
75 } __VERIFY_UINT8_ENUM_SIZE
;
78 __VerifyUint16EnumValue
= 0xffff
79 } __VERIFY_UINT16_ENUM_SIZE
;
82 __VerifyUint32EnumValue
= 0xffffffff
83 } __VERIFY_UINT32_ENUM_SIZE
;
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);
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
94 #if defined(_MSC_EXTENSIONS) && !defined (MDE_CPU_EBC)
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.
100 #define GLOBAL_REMOVE_IF_UNREFERENCED __declspec(selectany)
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.
107 #define GLOBAL_REMOVE_IF_UNREFERENCED
111 // Should be used in combination with NORETURN to avoid 'noreturn' returns
115 #if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ > 4)
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.
121 #define UNREACHABLE() __builtin_unreachable ()
122 #elif defined (__has_feature)
123 #if __has_builtin (__builtin_unreachable)
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.
128 #define UNREACHABLE() __builtin_unreachable ()
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.
137 #define UNREACHABLE()
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
147 #if defined (__GNUC__) || defined (__clang__)
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.
153 #define NORETURN __attribute__((noreturn))
154 #elif defined(_MSC_EXTENSIONS) && !defined(MDE_CPU_EBC)
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.
160 #define NORETURN __declspec(noreturn)
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.
172 // Should be used in combination with ANALYZER_NORETURN to avoid 'noreturn'
175 #ifndef ANALYZER_UNREACHABLE
176 #ifdef __clang_analyzer__
177 #if __has_builtin (__builtin_unreachable)
179 /// Signal the analyzer that this call is not reachable.
180 /// This excludes compilers.
182 #define ANALYZER_UNREACHABLE() __builtin_unreachable ()
186 #ifndef ANALYZER_UNREACHABLE
188 /// Signal the analyzer that this call is not reachable.
189 /// This excludes compilers.
191 #define ANALYZER_UNREACHABLE()
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()
201 #ifndef ANALYZER_NORETURN
203 #if __has_feature (attribute_analyzer_noreturn)
205 /// Signal analyzers that the function cannot return.
206 /// This excludes compilers.
208 #define ANALYZER_NORETURN __attribute__((analyzer_noreturn))
212 #ifndef ANALYZER_NORETURN
214 /// Signal the analyzer that the function cannot return.
215 /// This excludes compilers.
217 #define ANALYZER_NORETURN
222 // For symbol name in assembly code, an extra "_" is sometimes necessary
226 /// Private worker functions for ASM_PFX()
228 #define _CONCATENATE(a, b) __CONCATENATE(a, b)
229 #define __CONCATENATE(a, b) a ## b
232 /// The __USER_LABEL_PREFIX__ macro predefined by GNUC represents the prefix
233 /// on symbols in assembly language.
235 #define ASM_PFX(name) _CONCATENATE (__USER_LABEL_PREFIX__, name)
239 // Apple extension that is used by the linker to optimize code size
240 // with assembly functions. Put at the end of your .S files
242 #define ASM_FUNCTION_REMOVE_IF_UNREFERENCED .subsections_via_symbols
244 #define ASM_FUNCTION_REMOVE_IF_UNREFERENCED
249 // Older RVCT ARM compilers don't fully support #pragma pack and require __packed
250 // as a prefix for the structure.
252 #define PACKED __packed
258 /// 128 bit buffer containing a unique identifier value.
259 /// Unless otherwise specified, aligned on a 64 bit boundary.
269 // 8-bytes unsigned value that represents a physical system address.
271 typedef UINT64 PHYSICAL_ADDRESS
;
274 /// LIST_ENTRY structure definition.
276 typedef struct _LIST_ENTRY LIST_ENTRY
;
279 /// _LIST_ENTRY structure definition.
282 LIST_ENTRY
*ForwardLink
;
283 LIST_ENTRY
*BackLink
;
287 // Modifiers to abstract standard types to aid in debug of problems
291 /// Datum is read-only.
296 /// Datum is scoped to the current file or function.
298 #define STATIC static
306 // Modifiers for Data Types used to self document code.
307 // This concept is borrowed for UEFI specification.
311 /// Datum is passed to the function.
316 /// Datum is returned from the function.
321 /// Passing the datum to the function is optional, and a NULL
322 /// is passed if the value is not supplied.
327 // UEFI specification claims 1 and 0. We are concerned about the
328 // compiler portability so we did it this way.
332 /// Boolean true value. UEFI Specification defines this value to be 1,
333 /// but this form is more portable.
335 #define TRUE ((BOOLEAN)(1==1))
338 /// Boolean false value. UEFI Specification defines this value to be 0,
339 /// but this form is more portable.
341 #define FALSE ((BOOLEAN)(0==1))
344 /// NULL pointer (VOID *)
346 #define NULL ((VOID *) 0)
351 #define CHAR_NULL 0x0000
354 /// Maximum values for common UEFI Data Types
356 #define MAX_INT8 ((INT8)0x7F)
357 #define MAX_UINT8 ((UINT8)0xFF)
358 #define MAX_INT16 ((INT16)0x7FFF)
359 #define MAX_UINT16 ((UINT16)0xFFFF)
360 #define MAX_INT32 ((INT32)0x7FFFFFFF)
361 #define MAX_UINT32 ((UINT32)0xFFFFFFFF)
362 #define MAX_INT64 ((INT64)0x7FFFFFFFFFFFFFFFULL)
363 #define MAX_UINT64 ((UINT64)0xFFFFFFFFFFFFFFFFULL)
365 #define BIT0 0x00000001
366 #define BIT1 0x00000002
367 #define BIT2 0x00000004
368 #define BIT3 0x00000008
369 #define BIT4 0x00000010
370 #define BIT5 0x00000020
371 #define BIT6 0x00000040
372 #define BIT7 0x00000080
373 #define BIT8 0x00000100
374 #define BIT9 0x00000200
375 #define BIT10 0x00000400
376 #define BIT11 0x00000800
377 #define BIT12 0x00001000
378 #define BIT13 0x00002000
379 #define BIT14 0x00004000
380 #define BIT15 0x00008000
381 #define BIT16 0x00010000
382 #define BIT17 0x00020000
383 #define BIT18 0x00040000
384 #define BIT19 0x00080000
385 #define BIT20 0x00100000
386 #define BIT21 0x00200000
387 #define BIT22 0x00400000
388 #define BIT23 0x00800000
389 #define BIT24 0x01000000
390 #define BIT25 0x02000000
391 #define BIT26 0x04000000
392 #define BIT27 0x08000000
393 #define BIT28 0x10000000
394 #define BIT29 0x20000000
395 #define BIT30 0x40000000
396 #define BIT31 0x80000000
397 #define BIT32 0x0000000100000000ULL
398 #define BIT33 0x0000000200000000ULL
399 #define BIT34 0x0000000400000000ULL
400 #define BIT35 0x0000000800000000ULL
401 #define BIT36 0x0000001000000000ULL
402 #define BIT37 0x0000002000000000ULL
403 #define BIT38 0x0000004000000000ULL
404 #define BIT39 0x0000008000000000ULL
405 #define BIT40 0x0000010000000000ULL
406 #define BIT41 0x0000020000000000ULL
407 #define BIT42 0x0000040000000000ULL
408 #define BIT43 0x0000080000000000ULL
409 #define BIT44 0x0000100000000000ULL
410 #define BIT45 0x0000200000000000ULL
411 #define BIT46 0x0000400000000000ULL
412 #define BIT47 0x0000800000000000ULL
413 #define BIT48 0x0001000000000000ULL
414 #define BIT49 0x0002000000000000ULL
415 #define BIT50 0x0004000000000000ULL
416 #define BIT51 0x0008000000000000ULL
417 #define BIT52 0x0010000000000000ULL
418 #define BIT53 0x0020000000000000ULL
419 #define BIT54 0x0040000000000000ULL
420 #define BIT55 0x0080000000000000ULL
421 #define BIT56 0x0100000000000000ULL
422 #define BIT57 0x0200000000000000ULL
423 #define BIT58 0x0400000000000000ULL
424 #define BIT59 0x0800000000000000ULL
425 #define BIT60 0x1000000000000000ULL
426 #define BIT61 0x2000000000000000ULL
427 #define BIT62 0x4000000000000000ULL
428 #define BIT63 0x8000000000000000ULL
430 #define SIZE_1KB 0x00000400
431 #define SIZE_2KB 0x00000800
432 #define SIZE_4KB 0x00001000
433 #define SIZE_8KB 0x00002000
434 #define SIZE_16KB 0x00004000
435 #define SIZE_32KB 0x00008000
436 #define SIZE_64KB 0x00010000
437 #define SIZE_128KB 0x00020000
438 #define SIZE_256KB 0x00040000
439 #define SIZE_512KB 0x00080000
440 #define SIZE_1MB 0x00100000
441 #define SIZE_2MB 0x00200000
442 #define SIZE_4MB 0x00400000
443 #define SIZE_8MB 0x00800000
444 #define SIZE_16MB 0x01000000
445 #define SIZE_32MB 0x02000000
446 #define SIZE_64MB 0x04000000
447 #define SIZE_128MB 0x08000000
448 #define SIZE_256MB 0x10000000
449 #define SIZE_512MB 0x20000000
450 #define SIZE_1GB 0x40000000
451 #define SIZE_2GB 0x80000000
452 #define SIZE_4GB 0x0000000100000000ULL
453 #define SIZE_8GB 0x0000000200000000ULL
454 #define SIZE_16GB 0x0000000400000000ULL
455 #define SIZE_32GB 0x0000000800000000ULL
456 #define SIZE_64GB 0x0000001000000000ULL
457 #define SIZE_128GB 0x0000002000000000ULL
458 #define SIZE_256GB 0x0000004000000000ULL
459 #define SIZE_512GB 0x0000008000000000ULL
460 #define SIZE_1TB 0x0000010000000000ULL
461 #define SIZE_2TB 0x0000020000000000ULL
462 #define SIZE_4TB 0x0000040000000000ULL
463 #define SIZE_8TB 0x0000080000000000ULL
464 #define SIZE_16TB 0x0000100000000000ULL
465 #define SIZE_32TB 0x0000200000000000ULL
466 #define SIZE_64TB 0x0000400000000000ULL
467 #define SIZE_128TB 0x0000800000000000ULL
468 #define SIZE_256TB 0x0001000000000000ULL
469 #define SIZE_512TB 0x0002000000000000ULL
470 #define SIZE_1PB 0x0004000000000000ULL
471 #define SIZE_2PB 0x0008000000000000ULL
472 #define SIZE_4PB 0x0010000000000000ULL
473 #define SIZE_8PB 0x0020000000000000ULL
474 #define SIZE_16PB 0x0040000000000000ULL
475 #define SIZE_32PB 0x0080000000000000ULL
476 #define SIZE_64PB 0x0100000000000000ULL
477 #define SIZE_128PB 0x0200000000000000ULL
478 #define SIZE_256PB 0x0400000000000000ULL
479 #define SIZE_512PB 0x0800000000000000ULL
480 #define SIZE_1EB 0x1000000000000000ULL
481 #define SIZE_2EB 0x2000000000000000ULL
482 #define SIZE_4EB 0x4000000000000000ULL
483 #define SIZE_8EB 0x8000000000000000ULL
485 #define BASE_1KB 0x00000400
486 #define BASE_2KB 0x00000800
487 #define BASE_4KB 0x00001000
488 #define BASE_8KB 0x00002000
489 #define BASE_16KB 0x00004000
490 #define BASE_32KB 0x00008000
491 #define BASE_64KB 0x00010000
492 #define BASE_128KB 0x00020000
493 #define BASE_256KB 0x00040000
494 #define BASE_512KB 0x00080000
495 #define BASE_1MB 0x00100000
496 #define BASE_2MB 0x00200000
497 #define BASE_4MB 0x00400000
498 #define BASE_8MB 0x00800000
499 #define BASE_16MB 0x01000000
500 #define BASE_32MB 0x02000000
501 #define BASE_64MB 0x04000000
502 #define BASE_128MB 0x08000000
503 #define BASE_256MB 0x10000000
504 #define BASE_512MB 0x20000000
505 #define BASE_1GB 0x40000000
506 #define BASE_2GB 0x80000000
507 #define BASE_4GB 0x0000000100000000ULL
508 #define BASE_8GB 0x0000000200000000ULL
509 #define BASE_16GB 0x0000000400000000ULL
510 #define BASE_32GB 0x0000000800000000ULL
511 #define BASE_64GB 0x0000001000000000ULL
512 #define BASE_128GB 0x0000002000000000ULL
513 #define BASE_256GB 0x0000004000000000ULL
514 #define BASE_512GB 0x0000008000000000ULL
515 #define BASE_1TB 0x0000010000000000ULL
516 #define BASE_2TB 0x0000020000000000ULL
517 #define BASE_4TB 0x0000040000000000ULL
518 #define BASE_8TB 0x0000080000000000ULL
519 #define BASE_16TB 0x0000100000000000ULL
520 #define BASE_32TB 0x0000200000000000ULL
521 #define BASE_64TB 0x0000400000000000ULL
522 #define BASE_128TB 0x0000800000000000ULL
523 #define BASE_256TB 0x0001000000000000ULL
524 #define BASE_512TB 0x0002000000000000ULL
525 #define BASE_1PB 0x0004000000000000ULL
526 #define BASE_2PB 0x0008000000000000ULL
527 #define BASE_4PB 0x0010000000000000ULL
528 #define BASE_8PB 0x0020000000000000ULL
529 #define BASE_16PB 0x0040000000000000ULL
530 #define BASE_32PB 0x0080000000000000ULL
531 #define BASE_64PB 0x0100000000000000ULL
532 #define BASE_128PB 0x0200000000000000ULL
533 #define BASE_256PB 0x0400000000000000ULL
534 #define BASE_512PB 0x0800000000000000ULL
535 #define BASE_1EB 0x1000000000000000ULL
536 #define BASE_2EB 0x2000000000000000ULL
537 #define BASE_4EB 0x4000000000000000ULL
538 #define BASE_8EB 0x8000000000000000ULL
541 // Support for variable length argument lists using the ANSI standard.
543 // Since we are using the ANSI standard we used the standard naming and
544 // did not follow the coding convention
546 // VA_LIST - typedef for argument list.
547 // VA_START (VA_LIST Marker, argument before the ...) - Init Marker for use.
548 // VA_END (VA_LIST Marker) - Clear Marker
549 // VA_ARG (VA_LIST Marker, var arg size) - Use Marker to get an argument from
550 // the ... list. You must know the size and pass it in this macro.
551 // VA_COPY (VA_LIST Dest, VA_LIST Start) - Initialize Dest as a copy of Start.
557 // IN UINTN NumberOfArgs,
566 // // Initialize the Marker
568 // VA_START (Marker, NumberOfArgs);
569 // for (Index = 0, Result = 0; Index < NumberOfArgs; Index++) {
571 // // The ... list is a series of UINTN values, so average them up.
573 // Result += VA_ARG (Marker, UINTN);
582 Return the size of argument that has been aligned to sizeof (UINTN).
584 @param n The parameter size to be aligned.
586 @return The aligned size.
588 #define _INT_SIZE_OF(n) ((sizeof (n) + sizeof (UINTN) - 1) &~(sizeof (UINTN) - 1))
590 #if defined(__CC_ARM)
592 // RVCT ARM variable argument list support.
596 /// Variable used to traverse the list of arguments. This type can vary by
597 /// implementation and could be an array or structure.
600 typedef int *va_list[1];
601 #define VA_LIST va_list
603 typedef struct __va_list
{ void *__ap
; } va_list;
604 #define VA_LIST va_list
607 #define VA_START(Marker, Parameter) __va_start(Marker, Parameter)
609 #define VA_ARG(Marker, TYPE) __va_arg(Marker, TYPE)
611 #define VA_END(Marker) ((void)0)
613 // For some ARM RVCT compilers, __va_copy is not defined
615 #define __va_copy(dest, src) ((void)((dest) = (src)))
618 #define VA_COPY(Dest, Start) __va_copy (Dest, Start)
620 #elif defined(__GNUC__)
622 #if defined(MDE_CPU_X64) && !defined(NO_MSABI_VA_FUNCS)
624 // X64 only. Use MS ABI version of GCC built-in macros for variable argument lists.
627 /// Both GCC and LLVM 3.8 for X64 support new variable argument intrinsics for Microsoft ABI
631 /// Variable used to traverse the list of arguments. This type can vary by
632 /// implementation and could be an array or structure.
634 typedef __builtin_ms_va_list VA_LIST
;
636 #define VA_START(Marker, Parameter) __builtin_ms_va_start (Marker, Parameter)
638 #define VA_ARG(Marker, TYPE) ((sizeof (TYPE) < sizeof (UINTN)) ? (TYPE)(__builtin_va_arg (Marker, UINTN)) : (TYPE)(__builtin_va_arg (Marker, TYPE)))
640 #define VA_END(Marker) __builtin_ms_va_end (Marker)
642 #define VA_COPY(Dest, Start) __builtin_ms_va_copy (Dest, Start)
646 // Use GCC built-in macros for variable argument lists.
650 /// Variable used to traverse the list of arguments. This type can vary by
651 /// implementation and could be an array or structure.
653 typedef __builtin_va_list VA_LIST
;
655 #define VA_START(Marker, Parameter) __builtin_va_start (Marker, Parameter)
657 #define VA_ARG(Marker, TYPE) ((sizeof (TYPE) < sizeof (UINTN)) ? (TYPE)(__builtin_va_arg (Marker, UINTN)) : (TYPE)(__builtin_va_arg (Marker, TYPE)))
659 #define VA_END(Marker) __builtin_va_end (Marker)
661 #define VA_COPY(Dest, Start) __builtin_va_copy (Dest, Start)
667 /// Variable used to traverse the list of arguments. This type can vary by
668 /// implementation and could be an array or structure.
670 typedef CHAR8
*VA_LIST
;
673 Retrieves a pointer to the beginning of a variable argument list, based on
674 the name of the parameter that immediately precedes the variable argument list.
676 This function initializes Marker to point to the beginning of the variable
677 argument list that immediately follows Parameter. The method for computing the
678 pointer to the next argument in the argument list is CPU-specific following the
681 @param Marker The VA_LIST used to traverse the list of arguments.
682 @param Parameter The name of the parameter that immediately precedes
683 the variable argument list.
685 @return A pointer to the beginning of a variable argument list.
688 #define VA_START(Marker, Parameter) (Marker = (VA_LIST) ((UINTN) & (Parameter) + _INT_SIZE_OF (Parameter)))
691 Returns an argument of a specified type from a variable argument list and updates
692 the pointer to the variable argument list to point to the next argument.
694 This function returns an argument of the type specified by TYPE from the beginning
695 of the variable argument list specified by Marker. Marker is then updated to point
696 to the next argument in the variable argument list. The method for computing the
697 pointer to the next argument in the argument list is CPU-specific following the EFIAPI ABI.
699 @param Marker VA_LIST used to traverse the list of arguments.
700 @param TYPE The type of argument to retrieve from the beginning
701 of the variable argument list.
703 @return An argument of the type specified by TYPE.
706 #define VA_ARG(Marker, TYPE) (*(TYPE *) ((Marker += _INT_SIZE_OF (TYPE)) - _INT_SIZE_OF (TYPE)))
709 Terminates the use of a variable argument list.
711 This function initializes Marker so it can no longer be used with VA_ARG().
712 After this macro is used, the only way to access the variable argument list is
713 by using VA_START() again.
715 @param Marker VA_LIST used to traverse the list of arguments.
718 #define VA_END(Marker) (Marker = (VA_LIST) 0)
721 Initializes a VA_LIST as a copy of an existing VA_LIST.
723 This macro initializes Dest as a copy of Start, as if the VA_START macro had been applied to Dest
724 followed by the same sequence of uses of the VA_ARG macro as had previously been used to reach
725 the present state of Start.
727 @param Dest VA_LIST used to traverse the list of arguments.
728 @param Start VA_LIST used to traverse the list of arguments.
731 #define VA_COPY(Dest, Start) ((void)((Dest) = (Start)))
736 /// Pointer to the start of a variable argument list stored in a memory buffer. Same as UINT8 *.
738 typedef UINTN
*BASE_LIST
;
741 Returns the size of a data type in sizeof(UINTN) units rounded up to the nearest UINTN boundary.
743 @param TYPE The date type to determine the size of.
745 @return The size of TYPE in sizeof (UINTN) units rounded up to the nearest UINTN boundary.
747 #define _BASE_INT_SIZE_OF(TYPE) ((sizeof (TYPE) + sizeof (UINTN) - 1) / sizeof (UINTN))
750 Returns an argument of a specified type from a variable argument list and updates
751 the pointer to the variable argument list to point to the next argument.
753 This function returns an argument of the type specified by TYPE from the beginning
754 of the variable argument list specified by Marker. Marker is then updated to point
755 to the next argument in the variable argument list. The method for computing the
756 pointer to the next argument in the argument list is CPU specific following the EFIAPI ABI.
758 @param Marker The pointer to the beginning of a variable argument list.
759 @param TYPE The type of argument to retrieve from the beginning
760 of the variable argument list.
762 @return An argument of the type specified by TYPE.
765 #define BASE_ARG(Marker, TYPE) (*(TYPE *) ((Marker += _BASE_INT_SIZE_OF (TYPE)) - _BASE_INT_SIZE_OF (TYPE)))
768 The macro that returns the byte offset of a field in a data structure.
770 This function returns the offset, in bytes, of field specified by Field from the
771 beginning of the data structure specified by TYPE. If TYPE does not contain Field,
772 the module will not compile.
774 @param TYPE The name of the data structure that contains the field specified by Field.
775 @param Field The name of the field in the data structure.
777 @return Offset, in bytes, of field.
782 #define OFFSET_OF(TYPE, Field) ((UINTN) __builtin_offsetof(TYPE, Field))
787 #define OFFSET_OF(TYPE, Field) ((UINTN) &(((TYPE *)0)->Field))
791 Macro that returns a pointer to the data structure that contains a specified field of
792 that data structure. This is a lightweight method to hide information by placing a
793 public data structure inside a larger private data structure and using a pointer to
794 the public data structure to retrieve a pointer to the private data structure.
796 This function computes the offset, in bytes, of field specified by Field from the beginning
797 of the data structure specified by TYPE. This offset is subtracted from Record, and is
798 used to return a pointer to a data structure of the type specified by TYPE. If the data type
799 specified by TYPE does not contain the field specified by Field, then the module will not compile.
801 @param Record Pointer to the field specified by Field within a data structure of type TYPE.
802 @param TYPE The name of the data structure type to return. This data structure must
803 contain the field specified by Field.
804 @param Field The name of the field in the data structure specified by TYPE to which Record points.
806 @return A pointer to the structure from one of it's elements.
809 #define BASE_CR(Record, TYPE, Field) ((TYPE *) ((CHAR8 *) (Record) - (CHAR8 *) &(((TYPE *) 0)->Field)))
812 Rounds a value up to the next boundary using a specified alignment.
814 This function rounds Value up to the next boundary using the specified Alignment.
815 This aligned value is returned.
817 @param Value The value to round up.
818 @param Alignment The alignment boundary used to return the aligned value.
820 @return A value up to the next boundary.
823 #define ALIGN_VALUE(Value, Alignment) ((Value) + (((Alignment) - (Value)) & ((Alignment) - 1)))
826 Adjust a pointer by adding the minimum offset required for it to be aligned on
827 a specified alignment boundary.
829 This function rounds the pointer specified by Pointer to the next alignment boundary
830 specified by Alignment. The pointer to the aligned address is returned.
832 @param Pointer The pointer to round up.
833 @param Alignment The alignment boundary to use to return an aligned pointer.
835 @return Pointer to the aligned address.
838 #define ALIGN_POINTER(Pointer, Alignment) ((VOID *) (ALIGN_VALUE ((UINTN)(Pointer), (Alignment))))
841 Rounds a value up to the next natural boundary for the current CPU.
842 This is 4-bytes for 32-bit CPUs and 8-bytes for 64-bit CPUs.
844 This function rounds the value specified by Value up to the next natural boundary for the
845 current CPU. This rounded value is returned.
847 @param Value The value to round up.
849 @return Rounded value specified by Value.
852 #define ALIGN_VARIABLE(Value) ALIGN_VALUE ((Value), sizeof (UINTN))
856 Return the maximum of two operands.
858 This macro returns the maximum of two operand specified by a and b.
859 Both a and b must be the same numerical types, signed or unsigned.
861 @param a The first operand with any numerical type.
862 @param b The second operand. Can be any numerical type as long as is
865 @return Maximum of two operands.
869 (((a) > (b)) ? (a) : (b))
872 Return the minimum of two operands.
874 This macro returns the minimal of two operand specified by a and b.
875 Both a and b must be the same numerical types, signed or unsigned.
877 @param a The first operand with any numerical type.
878 @param b The second operand. It should be the same any numerical type with a.
880 @return Minimum of two operands.
884 (((a) < (b)) ? (a) : (b))
887 Return the absolute value of a signed operand.
889 This macro returns the absolute value of the signed operand specified by a.
891 @param a The signed operand.
893 @return The absolute value of the signed operand.
897 (((a) < 0) ? (-(a)) : (a))
900 // Status codes common to all execution phases
902 typedef UINTN RETURN_STATUS
;
905 Produces a RETURN_STATUS code with the highest bit set.
907 @param StatusCode The status code value to convert into a warning code.
908 StatusCode must be in the range 0x00000000..0x7FFFFFFF.
910 @return The value specified by StatusCode with the highest bit set.
913 #define ENCODE_ERROR(StatusCode) ((RETURN_STATUS)(MAX_BIT | (StatusCode)))
916 Produces a RETURN_STATUS code with the highest bit clear.
918 @param StatusCode The status code value to convert into a warning code.
919 StatusCode must be in the range 0x00000000..0x7FFFFFFF.
921 @return The value specified by StatusCode with the highest bit clear.
924 #define ENCODE_WARNING(StatusCode) ((RETURN_STATUS)(StatusCode))
927 Returns TRUE if a specified RETURN_STATUS code is an error code.
929 This function returns TRUE if StatusCode has the high bit set. Otherwise, FALSE is returned.
931 @param StatusCode The status code value to evaluate.
933 @retval TRUE The high bit of StatusCode is set.
934 @retval FALSE The high bit of StatusCode is clear.
937 #define RETURN_ERROR(StatusCode) (((INTN)(RETURN_STATUS)(StatusCode)) < 0)
940 /// The operation completed successfully.
942 #define RETURN_SUCCESS 0
945 /// The image failed to load.
947 #define RETURN_LOAD_ERROR ENCODE_ERROR (1)
950 /// The parameter was incorrect.
952 #define RETURN_INVALID_PARAMETER ENCODE_ERROR (2)
955 /// The operation is not supported.
957 #define RETURN_UNSUPPORTED ENCODE_ERROR (3)
960 /// The buffer was not the proper size for the request.
962 #define RETURN_BAD_BUFFER_SIZE ENCODE_ERROR (4)
965 /// The buffer was not large enough to hold the requested data.
966 /// The required buffer size is returned in the appropriate
967 /// parameter when this error occurs.
969 #define RETURN_BUFFER_TOO_SMALL ENCODE_ERROR (5)
972 /// There is no data pending upon return.
974 #define RETURN_NOT_READY ENCODE_ERROR (6)
977 /// The physical device reported an error while attempting the
980 #define RETURN_DEVICE_ERROR ENCODE_ERROR (7)
983 /// The device can not be written to.
985 #define RETURN_WRITE_PROTECTED ENCODE_ERROR (8)
988 /// The resource has run out.
990 #define RETURN_OUT_OF_RESOURCES ENCODE_ERROR (9)
993 /// An inconsistency was detected on the file system causing the
994 /// operation to fail.
996 #define RETURN_VOLUME_CORRUPTED ENCODE_ERROR (10)
999 /// There is no more space on the file system.
1001 #define RETURN_VOLUME_FULL ENCODE_ERROR (11)
1004 /// The device does not contain any medium to perform the
1007 #define RETURN_NO_MEDIA ENCODE_ERROR (12)
1010 /// The medium in the device has changed since the last
1013 #define RETURN_MEDIA_CHANGED ENCODE_ERROR (13)
1016 /// The item was not found.
1018 #define RETURN_NOT_FOUND ENCODE_ERROR (14)
1021 /// Access was denied.
1023 #define RETURN_ACCESS_DENIED ENCODE_ERROR (15)
1026 /// The server was not found or did not respond to the request.
1028 #define RETURN_NO_RESPONSE ENCODE_ERROR (16)
1031 /// A mapping to the device does not exist.
1033 #define RETURN_NO_MAPPING ENCODE_ERROR (17)
1036 /// A timeout time expired.
1038 #define RETURN_TIMEOUT ENCODE_ERROR (18)
1041 /// The protocol has not been started.
1043 #define RETURN_NOT_STARTED ENCODE_ERROR (19)
1046 /// The protocol has already been started.
1048 #define RETURN_ALREADY_STARTED ENCODE_ERROR (20)
1051 /// The operation was aborted.
1053 #define RETURN_ABORTED ENCODE_ERROR (21)
1056 /// An ICMP error occurred during the network operation.
1058 #define RETURN_ICMP_ERROR ENCODE_ERROR (22)
1061 /// A TFTP error occurred during the network operation.
1063 #define RETURN_TFTP_ERROR ENCODE_ERROR (23)
1066 /// A protocol error occurred during the network operation.
1068 #define RETURN_PROTOCOL_ERROR ENCODE_ERROR (24)
1071 /// A function encountered an internal version that was
1072 /// incompatible with a version requested by the caller.
1074 #define RETURN_INCOMPATIBLE_VERSION ENCODE_ERROR (25)
1077 /// The function was not performed due to a security violation.
1079 #define RETURN_SECURITY_VIOLATION ENCODE_ERROR (26)
1082 /// A CRC error was detected.
1084 #define RETURN_CRC_ERROR ENCODE_ERROR (27)
1087 /// The beginning or end of media was reached.
1089 #define RETURN_END_OF_MEDIA ENCODE_ERROR (28)
1092 /// The end of the file was reached.
1094 #define RETURN_END_OF_FILE ENCODE_ERROR (31)
1097 /// The language specified was invalid.
1099 #define RETURN_INVALID_LANGUAGE ENCODE_ERROR (32)
1102 /// The security status of the data is unknown or compromised
1103 /// and the data must be updated or replaced to restore a valid
1104 /// security status.
1106 #define RETURN_COMPROMISED_DATA ENCODE_ERROR (33)
1109 /// A HTTP error occurred during the network operation.
1111 #define RETURN_HTTP_ERROR ENCODE_ERROR (35)
1114 /// The string contained one or more characters that
1115 /// the device could not render and were skipped.
1117 #define RETURN_WARN_UNKNOWN_GLYPH ENCODE_WARNING (1)
1120 /// The handle was closed, but the file was not deleted.
1122 #define RETURN_WARN_DELETE_FAILURE ENCODE_WARNING (2)
1125 /// The handle was closed, but the data to the file was not
1126 /// flushed properly.
1128 #define RETURN_WARN_WRITE_FAILURE ENCODE_WARNING (3)
1131 /// The resulting buffer was too small, and the data was
1132 /// truncated to the buffer size.
1134 #define RETURN_WARN_BUFFER_TOO_SMALL ENCODE_WARNING (4)
1137 /// The data has not been updated within the timeframe set by
1138 /// local policy for this type of data.
1140 #define RETURN_WARN_STALE_DATA ENCODE_WARNING (5)
1143 /// The resulting buffer contains UEFI-compliant file system.
1145 #define RETURN_WARN_FILE_SYSTEM ENCODE_WARNING (6)
1149 Returns a 16-bit signature built from 2 ASCII characters.
1151 This macro returns a 16-bit value built from the two ASCII characters specified
1154 @param A The first ASCII character.
1155 @param B The second ASCII character.
1157 @return A 16-bit value built from the two ASCII characters specified by A and B.
1160 #define SIGNATURE_16(A, B) ((A) | (B << 8))
1163 Returns a 32-bit signature built from 4 ASCII characters.
1165 This macro returns a 32-bit value built from the four ASCII characters specified
1168 @param A The first ASCII character.
1169 @param B The second ASCII character.
1170 @param C The third ASCII character.
1171 @param D The fourth ASCII character.
1173 @return A 32-bit value built from the two ASCII characters specified by A, B,
1177 #define SIGNATURE_32(A, B, C, D) (SIGNATURE_16 (A, B) | (SIGNATURE_16 (C, D) << 16))
1180 Returns a 64-bit signature built from 8 ASCII characters.
1182 This macro returns a 64-bit value built from the eight ASCII characters specified
1183 by A, B, C, D, E, F, G,and H.
1185 @param A The first ASCII character.
1186 @param B The second ASCII character.
1187 @param C The third ASCII character.
1188 @param D The fourth ASCII character.
1189 @param E The fifth ASCII character.
1190 @param F The sixth ASCII character.
1191 @param G The seventh ASCII character.
1192 @param H The eighth ASCII character.
1194 @return A 64-bit value built from the two ASCII characters specified by A, B,
1195 C, D, E, F, G and H.
1198 #define SIGNATURE_64(A, B, C, D, E, F, G, H) \
1199 (SIGNATURE_32 (A, B, C, D) | ((UINT64) (SIGNATURE_32 (E, F, G, H)) << 32))
1201 #if defined(_MSC_EXTENSIONS) && !defined (__INTEL_COMPILER) && !defined (MDE_CPU_EBC)
1202 #pragma intrinsic(_ReturnAddress)
1204 Get the return address of the calling function.
1206 Based on intrinsic function _ReturnAddress that provides the address of
1207 the instruction in the calling function that will be executed after
1208 control returns to the caller.
1210 @param L Return Level.
1212 @return The return address of the calling function or 0 if L != 0.
1215 #define RETURN_ADDRESS(L) ((L == 0) ? _ReturnAddress() : (VOID *) 0)
1216 #elif defined(__GNUC__)
1217 void * __builtin_return_address (unsigned int level
);
1219 Get the return address of the calling function.
1221 Based on built-in Function __builtin_return_address that returns
1222 the return address of the current function, or of one of its callers.
1224 @param L Return Level.
1226 @return The return address of the calling function.
1229 #define RETURN_ADDRESS(L) __builtin_return_address (L)
1232 Get the return address of the calling function.
1234 @param L Return Level.
1236 @return 0 as compilers don't support this feature.
1239 #define RETURN_ADDRESS(L) ((VOID *) 0)
1243 Return the number of elements in an array.
1245 @param Array An object of array type. Array is only used as an argument to
1246 the sizeof operator, therefore Array is never evaluated. The
1247 caller is responsible for ensuring that Array's type is not
1248 incomplete; that is, Array must have known constant size.
1250 @return The number of elements in Array. The result has type UINTN.
1253 #define ARRAY_SIZE(Array) (sizeof (Array) / sizeof ((Array)[0]))