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 - 2021, Intel Corporation. All rights reserved.<BR>
10 Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>
11 SPDX-License-Identifier: BSD-2-Clause-Patent
19 // Include processor specific binding
21 #include <ProcessorBind.h>
23 #if defined (_MSC_EXTENSIONS)
25 // Disable warning when last field of data structure is a zero sized array.
27 #pragma warning ( disable : 4200 )
31 // The Microsoft* C compiler can removed references to unreferenced data items
32 // if the /OPT:REF linker option is used. We defined a macro as this is a
33 // a non standard extension
35 #if defined (_MSC_VER) && _MSC_VER < 1800 && !defined (MDE_CPU_EBC)
37 /// Remove global variable from the linked image if there are no references to
38 /// it after all compiler and linker optimizations have been performed.
41 #define GLOBAL_REMOVE_IF_UNREFERENCED __declspec(selectany)
44 /// Remove the global variable from the linked image if there are no references
45 /// to it after all compiler and linker optimizations have been performed.
48 #define GLOBAL_REMOVE_IF_UNREFERENCED
52 // Should be used in combination with NORETURN to avoid 'noreturn' returns
58 /// Signal compilers and analyzers that this call is not reachable. It is
59 /// up to the compiler to remove any code past that point.
61 #define UNREACHABLE() __builtin_unreachable ()
62 #elif defined (__has_feature)
63 #if __has_builtin (__builtin_unreachable)
65 /// Signal compilers and analyzers that this call is not reachable. It is
66 /// up to the compiler to remove any code past that point.
68 #define UNREACHABLE() __builtin_unreachable ()
74 /// Signal compilers and analyzers that this call is not reachable. It is
75 /// up to the compiler to remove any code past that point.
82 // Signaling compilers and analyzers that a certain function cannot return may
83 // remove all following code and thus lead to better optimization and less
87 #if defined (__GNUC__) || defined (__clang__)
89 /// Signal compilers and analyzers that the function cannot return.
90 /// It is up to the compiler to remove any code past a call to functions
91 /// flagged with this attribute.
93 #define NORETURN __attribute__((noreturn))
94 #elif defined (_MSC_EXTENSIONS) && !defined (MDE_CPU_EBC)
96 /// Signal compilers and analyzers that the function cannot return.
97 /// It is up to the compiler to remove any code past a call to functions
98 /// flagged with this attribute.
100 #define NORETURN __declspec(noreturn)
103 /// Signal compilers and analyzers that the function cannot return.
104 /// It is up to the compiler to remove any code past a call to functions
105 /// flagged with this attribute.
112 // Should be used in combination with ANALYZER_NORETURN to avoid 'noreturn'
115 #ifndef ANALYZER_UNREACHABLE
116 #ifdef __clang_analyzer__
117 #if __has_builtin (__builtin_unreachable)
119 /// Signal the analyzer that this call is not reachable.
120 /// This excludes compilers.
122 #define ANALYZER_UNREACHABLE() __builtin_unreachable ()
126 #ifndef ANALYZER_UNREACHABLE
128 /// Signal the analyzer that this call is not reachable.
129 /// This excludes compilers.
131 #define ANALYZER_UNREACHABLE()
136 // Static Analyzers may issue errors about potential NULL-dereferences when
137 // dereferencing a pointer, that has been checked before, outside of a
138 // NULL-check. This may lead to false positives, such as when using ASSERT()
141 #ifndef ANALYZER_NORETURN
143 #if __has_feature (attribute_analyzer_noreturn)
145 /// Signal analyzers that the function cannot return.
146 /// This excludes compilers.
148 #define ANALYZER_NORETURN __attribute__((analyzer_noreturn))
152 #ifndef ANALYZER_NORETURN
154 /// Signal the analyzer that the function cannot return.
155 /// This excludes compilers.
157 #define ANALYZER_NORETURN
162 /// Tell the code optimizer that the function will return twice.
163 /// This prevents wrong optimizations which can cause bugs.
165 #ifndef RETURNS_TWICE
166 #if defined (__GNUC__) || defined (__clang__)
168 /// Tell the code optimizer that the function will return twice.
169 /// This prevents wrong optimizations which can cause bugs.
171 #define RETURNS_TWICE __attribute__((returns_twice))
174 /// Tell the code optimizer that the function will return twice.
175 /// This prevents wrong optimizations which can cause bugs.
177 #define RETURNS_TWICE
182 // For symbol name in assembly code, an extra "_" is sometimes necessary
186 /// Private worker functions for ASM_PFX()
188 #define _CONCATENATE(a, b) __CONCATENATE(a, b)
189 #define __CONCATENATE(a, b) a ## b
192 /// The __USER_LABEL_PREFIX__ macro predefined by GNUC represents the prefix
193 /// on symbols in assembly language.
195 #define ASM_PFX(name) _CONCATENATE (__USER_LABEL_PREFIX__, name)
199 // Apple extension that is used by the linker to optimize code size
200 // with assembly functions. Put at the end of your .S files
202 #define ASM_FUNCTION_REMOVE_IF_UNREFERENCED .subsections_via_symbols
204 #define ASM_FUNCTION_REMOVE_IF_UNREFERENCED
209 // Older RVCT ARM compilers don't fully support #pragma pack and require __packed
210 // as a prefix for the structure.
212 #define PACKED __packed
218 /// 128 bit buffer containing a unique identifier value.
219 /// Unless otherwise specified, aligned on a 64 bit boundary.
229 /// 4-byte buffer. An IPv4 internet protocol address.
236 /// 16-byte buffer. An IPv6 internet protocol address.
243 // 8-bytes unsigned value that represents a physical system address.
245 typedef UINT64 PHYSICAL_ADDRESS
;
248 /// LIST_ENTRY structure definition.
250 typedef struct _LIST_ENTRY LIST_ENTRY
;
253 /// _LIST_ENTRY structure definition.
256 LIST_ENTRY
*ForwardLink
;
257 LIST_ENTRY
*BackLink
;
261 // Modifiers to abstract standard types to aid in debug of problems
265 /// Datum is read-only.
270 /// Datum is scoped to the current file or function.
272 #define STATIC static
280 // Modifiers for Data Types used to self document code.
281 // This concept is borrowed for UEFI specification.
285 /// Datum is passed to the function.
290 /// Datum is returned from the function.
295 /// Passing the datum to the function is optional, and a NULL
296 /// is passed if the value is not supplied.
301 // UEFI specification claims 1 and 0. We are concerned about the
302 // compiler portability so we did it this way.
306 /// Boolean true value. UEFI Specification defines this value to be 1,
307 /// but this form is more portable.
309 #define TRUE ((BOOLEAN)(1==1))
312 /// Boolean false value. UEFI Specification defines this value to be 0,
313 /// but this form is more portable.
315 #define FALSE ((BOOLEAN)(0==1))
318 /// NULL pointer (VOID *)
320 #define NULL ((VOID *) 0)
325 #define CHAR_NULL 0x0000
328 /// Maximum values for common UEFI Data Types
330 #define MAX_INT8 ((INT8)0x7F)
331 #define MAX_UINT8 ((UINT8)0xFF)
332 #define MAX_INT16 ((INT16)0x7FFF)
333 #define MAX_UINT16 ((UINT16)0xFFFF)
334 #define MAX_INT32 ((INT32)0x7FFFFFFF)
335 #define MAX_UINT32 ((UINT32)0xFFFFFFFF)
336 #define MAX_INT64 ((INT64)0x7FFFFFFFFFFFFFFFULL)
337 #define MAX_UINT64 ((UINT64)0xFFFFFFFFFFFFFFFFULL)
340 /// Minimum values for the signed UEFI Data Types
342 #define MIN_INT8 (((INT8) -127) - 1)
343 #define MIN_INT16 (((INT16) -32767) - 1)
344 #define MIN_INT32 (((INT32) -2147483647) - 1)
345 #define MIN_INT64 (((INT64) -9223372036854775807LL) - 1)
347 #define BIT0 0x00000001
348 #define BIT1 0x00000002
349 #define BIT2 0x00000004
350 #define BIT3 0x00000008
351 #define BIT4 0x00000010
352 #define BIT5 0x00000020
353 #define BIT6 0x00000040
354 #define BIT7 0x00000080
355 #define BIT8 0x00000100
356 #define BIT9 0x00000200
357 #define BIT10 0x00000400
358 #define BIT11 0x00000800
359 #define BIT12 0x00001000
360 #define BIT13 0x00002000
361 #define BIT14 0x00004000
362 #define BIT15 0x00008000
363 #define BIT16 0x00010000
364 #define BIT17 0x00020000
365 #define BIT18 0x00040000
366 #define BIT19 0x00080000
367 #define BIT20 0x00100000
368 #define BIT21 0x00200000
369 #define BIT22 0x00400000
370 #define BIT23 0x00800000
371 #define BIT24 0x01000000
372 #define BIT25 0x02000000
373 #define BIT26 0x04000000
374 #define BIT27 0x08000000
375 #define BIT28 0x10000000
376 #define BIT29 0x20000000
377 #define BIT30 0x40000000
378 #define BIT31 0x80000000
379 #define BIT32 0x0000000100000000ULL
380 #define BIT33 0x0000000200000000ULL
381 #define BIT34 0x0000000400000000ULL
382 #define BIT35 0x0000000800000000ULL
383 #define BIT36 0x0000001000000000ULL
384 #define BIT37 0x0000002000000000ULL
385 #define BIT38 0x0000004000000000ULL
386 #define BIT39 0x0000008000000000ULL
387 #define BIT40 0x0000010000000000ULL
388 #define BIT41 0x0000020000000000ULL
389 #define BIT42 0x0000040000000000ULL
390 #define BIT43 0x0000080000000000ULL
391 #define BIT44 0x0000100000000000ULL
392 #define BIT45 0x0000200000000000ULL
393 #define BIT46 0x0000400000000000ULL
394 #define BIT47 0x0000800000000000ULL
395 #define BIT48 0x0001000000000000ULL
396 #define BIT49 0x0002000000000000ULL
397 #define BIT50 0x0004000000000000ULL
398 #define BIT51 0x0008000000000000ULL
399 #define BIT52 0x0010000000000000ULL
400 #define BIT53 0x0020000000000000ULL
401 #define BIT54 0x0040000000000000ULL
402 #define BIT55 0x0080000000000000ULL
403 #define BIT56 0x0100000000000000ULL
404 #define BIT57 0x0200000000000000ULL
405 #define BIT58 0x0400000000000000ULL
406 #define BIT59 0x0800000000000000ULL
407 #define BIT60 0x1000000000000000ULL
408 #define BIT61 0x2000000000000000ULL
409 #define BIT62 0x4000000000000000ULL
410 #define BIT63 0x8000000000000000ULL
412 #define SIZE_1KB 0x00000400
413 #define SIZE_2KB 0x00000800
414 #define SIZE_4KB 0x00001000
415 #define SIZE_8KB 0x00002000
416 #define SIZE_16KB 0x00004000
417 #define SIZE_32KB 0x00008000
418 #define SIZE_64KB 0x00010000
419 #define SIZE_128KB 0x00020000
420 #define SIZE_256KB 0x00040000
421 #define SIZE_512KB 0x00080000
422 #define SIZE_1MB 0x00100000
423 #define SIZE_2MB 0x00200000
424 #define SIZE_4MB 0x00400000
425 #define SIZE_8MB 0x00800000
426 #define SIZE_16MB 0x01000000
427 #define SIZE_32MB 0x02000000
428 #define SIZE_64MB 0x04000000
429 #define SIZE_128MB 0x08000000
430 #define SIZE_256MB 0x10000000
431 #define SIZE_512MB 0x20000000
432 #define SIZE_1GB 0x40000000
433 #define SIZE_2GB 0x80000000
434 #define SIZE_4GB 0x0000000100000000ULL
435 #define SIZE_8GB 0x0000000200000000ULL
436 #define SIZE_16GB 0x0000000400000000ULL
437 #define SIZE_32GB 0x0000000800000000ULL
438 #define SIZE_64GB 0x0000001000000000ULL
439 #define SIZE_128GB 0x0000002000000000ULL
440 #define SIZE_256GB 0x0000004000000000ULL
441 #define SIZE_512GB 0x0000008000000000ULL
442 #define SIZE_1TB 0x0000010000000000ULL
443 #define SIZE_2TB 0x0000020000000000ULL
444 #define SIZE_4TB 0x0000040000000000ULL
445 #define SIZE_8TB 0x0000080000000000ULL
446 #define SIZE_16TB 0x0000100000000000ULL
447 #define SIZE_32TB 0x0000200000000000ULL
448 #define SIZE_64TB 0x0000400000000000ULL
449 #define SIZE_128TB 0x0000800000000000ULL
450 #define SIZE_256TB 0x0001000000000000ULL
451 #define SIZE_512TB 0x0002000000000000ULL
452 #define SIZE_1PB 0x0004000000000000ULL
453 #define SIZE_2PB 0x0008000000000000ULL
454 #define SIZE_4PB 0x0010000000000000ULL
455 #define SIZE_8PB 0x0020000000000000ULL
456 #define SIZE_16PB 0x0040000000000000ULL
457 #define SIZE_32PB 0x0080000000000000ULL
458 #define SIZE_64PB 0x0100000000000000ULL
459 #define SIZE_128PB 0x0200000000000000ULL
460 #define SIZE_256PB 0x0400000000000000ULL
461 #define SIZE_512PB 0x0800000000000000ULL
462 #define SIZE_1EB 0x1000000000000000ULL
463 #define SIZE_2EB 0x2000000000000000ULL
464 #define SIZE_4EB 0x4000000000000000ULL
465 #define SIZE_8EB 0x8000000000000000ULL
467 #define BASE_1KB 0x00000400
468 #define BASE_2KB 0x00000800
469 #define BASE_4KB 0x00001000
470 #define BASE_8KB 0x00002000
471 #define BASE_16KB 0x00004000
472 #define BASE_32KB 0x00008000
473 #define BASE_64KB 0x00010000
474 #define BASE_128KB 0x00020000
475 #define BASE_256KB 0x00040000
476 #define BASE_512KB 0x00080000
477 #define BASE_1MB 0x00100000
478 #define BASE_2MB 0x00200000
479 #define BASE_4MB 0x00400000
480 #define BASE_8MB 0x00800000
481 #define BASE_16MB 0x01000000
482 #define BASE_32MB 0x02000000
483 #define BASE_64MB 0x04000000
484 #define BASE_128MB 0x08000000
485 #define BASE_256MB 0x10000000
486 #define BASE_512MB 0x20000000
487 #define BASE_1GB 0x40000000
488 #define BASE_2GB 0x80000000
489 #define BASE_4GB 0x0000000100000000ULL
490 #define BASE_8GB 0x0000000200000000ULL
491 #define BASE_16GB 0x0000000400000000ULL
492 #define BASE_32GB 0x0000000800000000ULL
493 #define BASE_64GB 0x0000001000000000ULL
494 #define BASE_128GB 0x0000002000000000ULL
495 #define BASE_256GB 0x0000004000000000ULL
496 #define BASE_512GB 0x0000008000000000ULL
497 #define BASE_1TB 0x0000010000000000ULL
498 #define BASE_2TB 0x0000020000000000ULL
499 #define BASE_4TB 0x0000040000000000ULL
500 #define BASE_8TB 0x0000080000000000ULL
501 #define BASE_16TB 0x0000100000000000ULL
502 #define BASE_32TB 0x0000200000000000ULL
503 #define BASE_64TB 0x0000400000000000ULL
504 #define BASE_128TB 0x0000800000000000ULL
505 #define BASE_256TB 0x0001000000000000ULL
506 #define BASE_512TB 0x0002000000000000ULL
507 #define BASE_1PB 0x0004000000000000ULL
508 #define BASE_2PB 0x0008000000000000ULL
509 #define BASE_4PB 0x0010000000000000ULL
510 #define BASE_8PB 0x0020000000000000ULL
511 #define BASE_16PB 0x0040000000000000ULL
512 #define BASE_32PB 0x0080000000000000ULL
513 #define BASE_64PB 0x0100000000000000ULL
514 #define BASE_128PB 0x0200000000000000ULL
515 #define BASE_256PB 0x0400000000000000ULL
516 #define BASE_512PB 0x0800000000000000ULL
517 #define BASE_1EB 0x1000000000000000ULL
518 #define BASE_2EB 0x2000000000000000ULL
519 #define BASE_4EB 0x4000000000000000ULL
520 #define BASE_8EB 0x8000000000000000ULL
523 // Support for variable argument lists in freestanding edk2 modules.
525 // For modules that use the ISO C library interfaces for variable
526 // argument lists, refer to "StdLib/Include/stdarg.h".
528 // VA_LIST - typedef for argument list.
529 // VA_START (VA_LIST Marker, argument before the ...) - Init Marker for use.
530 // VA_END (VA_LIST Marker) - Clear Marker
531 // VA_ARG (VA_LIST Marker, var arg type) - Use Marker to get an argument from
532 // the ... list. You must know the type and pass it in this macro. Type
533 // must be compatible with the type of the actual next argument (as promoted
534 // according to the default argument promotions.)
535 // VA_COPY (VA_LIST Dest, VA_LIST Start) - Initialize Dest as a copy of Start.
542 // IN UINTN NumberOfArgs,
551 // // Initialize the Marker
553 // VA_START (Marker, NumberOfArgs);
554 // for (Index = 0, Result = 0; Index < NumberOfArgs; Index++) {
556 // // The ... list is a series of UINTN values, so sum them up.
558 // Result += VA_ARG (Marker, UINTN);
566 // - Functions that call VA_START() / VA_END() must have a variable
567 // argument list and must be declared EFIAPI.
568 // - Functions that call VA_COPY() / VA_END() must be declared EFIAPI.
569 // - Functions that only use VA_LIST and VA_ARG() need not be EFIAPI.
573 Return the size of argument that has been aligned to sizeof (UINTN).
575 @param n The parameter size to be aligned.
577 @return The aligned size.
579 #define _INT_SIZE_OF(n) ((sizeof (n) + sizeof (UINTN) - 1) &~(sizeof (UINTN) - 1))
581 #if defined (__CC_ARM)
583 // RVCT ARM variable argument list support.
587 /// Variable used to traverse the list of arguments. This type can vary by
588 /// implementation and could be an array or structure.
591 typedef int *va_list[1];
592 #define VA_LIST va_list
594 typedef struct __va_list
{
597 #define VA_LIST va_list
600 #define VA_START(Marker, Parameter) __va_start(Marker, Parameter)
602 #define VA_ARG(Marker, TYPE) __va_arg(Marker, TYPE)
604 #define VA_END(Marker) ((void)0)
606 // For some ARM RVCT compilers, __va_copy is not defined
608 #define __va_copy(dest, src) ((void)((dest) = (src)))
611 #define VA_COPY(Dest, Start) __va_copy (Dest, Start)
613 #elif defined (_M_ARM) || defined (_M_ARM64)
615 // MSFT ARM variable argument list support.
618 typedef char *VA_LIST
;
620 #define VA_START(Marker, Parameter) __va_start (&Marker, &Parameter, _INT_SIZE_OF (Parameter), __alignof(Parameter), &Parameter)
621 #define VA_ARG(Marker, TYPE) (*(TYPE *) ((Marker += _INT_SIZE_OF (TYPE) + ((-(INTN)Marker) & (sizeof(TYPE) - 1))) - _INT_SIZE_OF (TYPE)))
622 #define VA_END(Marker) (Marker = (VA_LIST) 0)
623 #define VA_COPY(Dest, Start) ((void)((Dest) = (Start)))
625 #elif defined (__GNUC__) || defined (__clang__)
627 #if defined (MDE_CPU_X64) && !defined (NO_MSABI_VA_FUNCS)
629 // X64 only. Use MS ABI version of GCC built-in macros for variable argument lists.
632 /// Both GCC and LLVM 3.8 for X64 support new variable argument intrinsics for Microsoft ABI
636 /// Variable used to traverse the list of arguments. This type can vary by
637 /// implementation and could be an array or structure.
639 typedef __builtin_ms_va_list VA_LIST
;
641 #define VA_START(Marker, Parameter) __builtin_ms_va_start (Marker, Parameter)
643 #define VA_ARG(Marker, TYPE) ((sizeof (TYPE) < sizeof (UINTN)) ? (TYPE)(__builtin_va_arg (Marker, UINTN)) : (TYPE)(__builtin_va_arg (Marker, TYPE)))
645 #define VA_END(Marker) __builtin_ms_va_end (Marker)
647 #define VA_COPY(Dest, Start) __builtin_ms_va_copy (Dest, Start)
651 // Use GCC built-in macros for variable argument lists.
655 /// Variable used to traverse the list of arguments. This type can vary by
656 /// implementation and could be an array or structure.
658 typedef __builtin_va_list VA_LIST
;
660 #define VA_START(Marker, Parameter) __builtin_va_start (Marker, Parameter)
662 #define VA_ARG(Marker, TYPE) ((sizeof (TYPE) < sizeof (UINTN)) ? (TYPE)(__builtin_va_arg (Marker, UINTN)) : (TYPE)(__builtin_va_arg (Marker, TYPE)))
664 #define VA_END(Marker) __builtin_va_end (Marker)
666 #define VA_COPY(Dest, Start) __builtin_va_copy (Dest, Start)
672 /// Variable used to traverse the list of arguments. This type can vary by
673 /// implementation and could be an array or structure.
675 typedef CHAR8
*VA_LIST
;
678 Retrieves a pointer to the beginning of a variable argument list, based on
679 the name of the parameter that immediately precedes the variable argument list.
681 This function initializes Marker to point to the beginning of the variable
682 argument list that immediately follows Parameter. The method for computing the
683 pointer to the next argument in the argument list is CPU-specific following the
686 @param Marker The VA_LIST used to traverse the list of arguments.
687 @param Parameter The name of the parameter that immediately precedes
688 the variable argument list.
690 @return A pointer to the beginning of a variable argument list.
693 #define VA_START(Marker, Parameter) (Marker = (VA_LIST) ((UINTN) & (Parameter) + _INT_SIZE_OF (Parameter)))
696 Returns an argument of a specified type from a variable argument list and updates
697 the pointer to the variable argument list to point to the next argument.
699 This function returns an argument of the type specified by TYPE from the beginning
700 of the variable argument list specified by Marker. Marker is then updated to point
701 to the next argument in the variable argument list. The method for computing the
702 pointer to the next argument in the argument list is CPU-specific following the EFIAPI ABI.
704 @param Marker VA_LIST used to traverse the list of arguments.
705 @param TYPE The type of argument to retrieve from the beginning
706 of the variable argument list.
708 @return An argument of the type specified by TYPE.
711 #define VA_ARG(Marker, TYPE) (*(TYPE *) ((Marker += _INT_SIZE_OF (TYPE)) - _INT_SIZE_OF (TYPE)))
714 Terminates the use of a variable argument list.
716 This function initializes Marker so it can no longer be used with VA_ARG().
717 After this macro is used, the only way to access the variable argument list is
718 by using VA_START() again.
720 @param Marker VA_LIST used to traverse the list of arguments.
723 #define VA_END(Marker) (Marker = (VA_LIST) 0)
726 Initializes a VA_LIST as a copy of an existing VA_LIST.
728 This macro initializes Dest as a copy of Start, as if the VA_START macro had been applied to Dest
729 followed by the same sequence of uses of the VA_ARG macro as had previously been used to reach
730 the present state of Start.
732 @param Dest VA_LIST used to traverse the list of arguments.
733 @param Start VA_LIST used to traverse the list of arguments.
736 #define VA_COPY(Dest, Start) ((void)((Dest) = (Start)))
741 /// Pointer to the start of a variable argument list stored in a memory buffer. Same as UINT8 *.
743 typedef UINTN
*BASE_LIST
;
746 Returns the size of a data type in sizeof(UINTN) units rounded up to the nearest UINTN boundary.
748 @param TYPE The date type to determine the size of.
750 @return The size of TYPE in sizeof (UINTN) units rounded up to the nearest UINTN boundary.
752 #define _BASE_INT_SIZE_OF(TYPE) ((sizeof (TYPE) + sizeof (UINTN) - 1) / sizeof (UINTN))
755 Returns an argument of a specified type from a variable argument list and updates
756 the pointer to the variable argument list to point to the next argument.
758 This function returns an argument of the type specified by TYPE from the beginning
759 of the variable argument list specified by Marker. Marker is then updated to point
760 to the next argument in the variable argument list. The method for computing the
761 pointer to the next argument in the argument list is CPU specific following the EFIAPI ABI.
763 @param Marker The pointer to the beginning of a variable argument list.
764 @param TYPE The type of argument to retrieve from the beginning
765 of the variable argument list.
767 @return An argument of the type specified by TYPE.
770 #define BASE_ARG(Marker, TYPE) (*(TYPE *) ((Marker += _BASE_INT_SIZE_OF (TYPE)) - _BASE_INT_SIZE_OF (TYPE)))
773 The macro that returns the byte offset of a field in a data structure.
775 This function returns the offset, in bytes, of field specified by Field from the
776 beginning of the data structure specified by TYPE. If TYPE does not contain Field,
777 the module will not compile.
779 @param TYPE The name of the data structure that contains the field specified by Field.
780 @param Field The name of the field in the data structure.
782 @return Offset, in bytes, of field.
785 #if (defined (__GNUC__) && __GNUC__ >= 4) || defined (__clang__)
786 #define OFFSET_OF(TYPE, Field) ((UINTN) __builtin_offsetof(TYPE, Field))
790 #define OFFSET_OF(TYPE, Field) ((UINTN) &(((TYPE *)0)->Field))
794 Portable definition for compile time assertions.
795 Equivalent to C11 static_assert macro from assert.h.
797 @param Expression Boolean expression.
798 @param Message Raised compiler diagnostic message when expression is false.
802 #define STATIC_ASSERT(Expression, Message)
803 #elif defined (_MSC_EXTENSIONS)
804 #define STATIC_ASSERT static_assert
806 #define STATIC_ASSERT _Static_assert
810 // Verify that ProcessorBind.h produced UEFI Data Types that are compliant with
811 // Section 2.3.1 of the UEFI 2.3 Specification.
814 STATIC_ASSERT (sizeof (BOOLEAN
) == 1, "sizeof (BOOLEAN) does not meet UEFI Specification Data Type requirements");
815 STATIC_ASSERT (sizeof (INT8
) == 1, "sizeof (INT8) does not meet UEFI Specification Data Type requirements");
816 STATIC_ASSERT (sizeof (UINT8
) == 1, "sizeof (UINT8) does not meet UEFI Specification Data Type requirements");
817 STATIC_ASSERT (sizeof (INT16
) == 2, "sizeof (INT16) does not meet UEFI Specification Data Type requirements");
818 STATIC_ASSERT (sizeof (UINT16
) == 2, "sizeof (UINT16) does not meet UEFI Specification Data Type requirements");
819 STATIC_ASSERT (sizeof (INT32
) == 4, "sizeof (INT32) does not meet UEFI Specification Data Type requirements");
820 STATIC_ASSERT (sizeof (UINT32
) == 4, "sizeof (UINT32) does not meet UEFI Specification Data Type requirements");
821 STATIC_ASSERT (sizeof (INT64
) == 8, "sizeof (INT64) does not meet UEFI Specification Data Type requirements");
822 STATIC_ASSERT (sizeof (UINT64
) == 8, "sizeof (UINT64) does not meet UEFI Specification Data Type requirements");
823 STATIC_ASSERT (sizeof (CHAR8
) == 1, "sizeof (CHAR8) does not meet UEFI Specification Data Type requirements");
824 STATIC_ASSERT (sizeof (CHAR16
) == 2, "sizeof (CHAR16) does not meet UEFI Specification Data Type requirements");
825 STATIC_ASSERT (sizeof (L
'A') == 2, "sizeof (L'A') does not meet UEFI Specification Data Type requirements");
826 STATIC_ASSERT (sizeof (L
"A") == 4, "sizeof (L\"A\") does not meet UEFI Specification Data Type requirements");
829 // The following three enum types are used to verify that the compiler
830 // configuration for enum types is compliant with Section 2.3.1 of the
831 // UEFI 2.3 Specification. These enum types and enum values are not
832 // intended to be used. A prefix of '__' is used avoid conflicts with
836 __VerifyUint8EnumValue
= 0xff
837 } __VERIFY_UINT8_ENUM_SIZE
;
840 __VerifyUint16EnumValue
= 0xffff
841 } __VERIFY_UINT16_ENUM_SIZE
;
844 __VerifyUint32EnumValue
= 0xffffffff
845 } __VERIFY_UINT32_ENUM_SIZE
;
847 STATIC_ASSERT (sizeof (__VERIFY_UINT8_ENUM_SIZE
) == 4, "Size of enum does not meet UEFI Specification Data Type requirements");
848 STATIC_ASSERT (sizeof (__VERIFY_UINT16_ENUM_SIZE
) == 4, "Size of enum does not meet UEFI Specification Data Type requirements");
849 STATIC_ASSERT (sizeof (__VERIFY_UINT32_ENUM_SIZE
) == 4, "Size of enum does not meet UEFI Specification Data Type requirements");
852 Macro that returns a pointer to the data structure that contains a specified field of
853 that data structure. This is a lightweight method to hide information by placing a
854 public data structure inside a larger private data structure and using a pointer to
855 the public data structure to retrieve a pointer to the private data structure.
857 This function computes the offset, in bytes, of field specified by Field from the beginning
858 of the data structure specified by TYPE. This offset is subtracted from Record, and is
859 used to return a pointer to a data structure of the type specified by TYPE. If the data type
860 specified by TYPE does not contain the field specified by Field, then the module will not compile.
862 @param Record Pointer to the field specified by Field within a data structure of type TYPE.
863 @param TYPE The name of the data structure type to return. This data structure must
864 contain the field specified by Field.
865 @param Field The name of the field in the data structure specified by TYPE to which Record points.
867 @return A pointer to the structure from one of it's elements.
870 #define BASE_CR(Record, TYPE, Field) ((TYPE *) ((CHAR8 *) (Record) - OFFSET_OF (TYPE, Field)))
873 Rounds a value up to the next boundary using a specified alignment.
875 This function rounds Value up to the next boundary using the specified Alignment.
876 This aligned value is returned.
878 @param Value The value to round up.
879 @param Alignment The alignment boundary used to return the aligned value.
881 @return A value up to the next boundary.
884 #define ALIGN_VALUE(Value, Alignment) ((Value) + (((Alignment) - (Value)) & ((Alignment) - 1)))
887 Adjust a pointer by adding the minimum offset required for it to be aligned on
888 a specified alignment boundary.
890 This function rounds the pointer specified by Pointer to the next alignment boundary
891 specified by Alignment. The pointer to the aligned address is returned.
893 @param Pointer The pointer to round up.
894 @param Alignment The alignment boundary to use to return an aligned pointer.
896 @return Pointer to the aligned address.
899 #define ALIGN_POINTER(Pointer, Alignment) ((VOID *) (ALIGN_VALUE ((UINTN)(Pointer), (Alignment))))
902 Rounds a value up to the next natural boundary for the current CPU.
903 This is 4-bytes for 32-bit CPUs and 8-bytes for 64-bit CPUs.
905 This function rounds the value specified by Value up to the next natural boundary for the
906 current CPU. This rounded value is returned.
908 @param Value The value to round up.
910 @return Rounded value specified by Value.
913 #define ALIGN_VARIABLE(Value) ALIGN_VALUE ((Value), sizeof (UINTN))
916 Return the maximum of two operands.
918 This macro returns the maximum of two operand specified by a and b.
919 Both a and b must be the same numerical types, signed or unsigned.
921 @param a The first operand with any numerical type.
922 @param b The second operand. Can be any numerical type as long as is
925 @return Maximum of two operands.
929 (((a) > (b)) ? (a) : (b))
932 Return the minimum of two operands.
934 This macro returns the minimal of two operand specified by a and b.
935 Both a and b must be the same numerical types, signed or unsigned.
937 @param a The first operand with any numerical type.
938 @param b The second operand. It should be the same any numerical type with a.
940 @return Minimum of two operands.
944 (((a) < (b)) ? (a) : (b))
947 Return the absolute value of a signed operand.
949 This macro returns the absolute value of the signed operand specified by a.
951 @param a The signed operand.
953 @return The absolute value of the signed operand.
957 (((a) < 0) ? (-(a)) : (a))
960 // Status codes common to all execution phases
962 typedef UINTN RETURN_STATUS
;
965 Produces a RETURN_STATUS code with the highest bit set.
967 @param StatusCode The status code value to convert into a warning code.
968 StatusCode must be in the range 0x00000000..0x7FFFFFFF.
970 @return The value specified by StatusCode with the highest bit set.
973 #define ENCODE_ERROR(StatusCode) ((RETURN_STATUS)(MAX_BIT | (StatusCode)))
976 Produces a RETURN_STATUS code with the highest bit clear.
978 @param StatusCode The status code value to convert into a warning code.
979 StatusCode must be in the range 0x00000000..0x7FFFFFFF.
981 @return The value specified by StatusCode with the highest bit clear.
984 #define ENCODE_WARNING(StatusCode) ((RETURN_STATUS)(StatusCode))
987 Returns TRUE if a specified RETURN_STATUS code is an error code.
989 This function returns TRUE if StatusCode has the high bit set. Otherwise, FALSE is returned.
991 @param StatusCode The status code value to evaluate.
993 @retval TRUE The high bit of StatusCode is set.
994 @retval FALSE The high bit of StatusCode is clear.
997 #define RETURN_ERROR(StatusCode) (((INTN)(RETURN_STATUS)(StatusCode)) < 0)
1000 /// The operation completed successfully.
1002 #define RETURN_SUCCESS 0
1005 /// The image failed to load.
1007 #define RETURN_LOAD_ERROR ENCODE_ERROR (1)
1010 /// The parameter was incorrect.
1012 #define RETURN_INVALID_PARAMETER ENCODE_ERROR (2)
1015 /// The operation is not supported.
1017 #define RETURN_UNSUPPORTED ENCODE_ERROR (3)
1020 /// The buffer was not the proper size for the request.
1022 #define RETURN_BAD_BUFFER_SIZE ENCODE_ERROR (4)
1025 /// The buffer was not large enough to hold the requested data.
1026 /// The required buffer size is returned in the appropriate
1027 /// parameter when this error occurs.
1029 #define RETURN_BUFFER_TOO_SMALL ENCODE_ERROR (5)
1032 /// There is no data pending upon return.
1034 #define RETURN_NOT_READY ENCODE_ERROR (6)
1037 /// The physical device reported an error while attempting the
1040 #define RETURN_DEVICE_ERROR ENCODE_ERROR (7)
1043 /// The device can not be written to.
1045 #define RETURN_WRITE_PROTECTED ENCODE_ERROR (8)
1048 /// The resource has run out.
1050 #define RETURN_OUT_OF_RESOURCES ENCODE_ERROR (9)
1053 /// An inconsistency was detected on the file system causing the
1054 /// operation to fail.
1056 #define RETURN_VOLUME_CORRUPTED ENCODE_ERROR (10)
1059 /// There is no more space on the file system.
1061 #define RETURN_VOLUME_FULL ENCODE_ERROR (11)
1064 /// The device does not contain any medium to perform the
1067 #define RETURN_NO_MEDIA ENCODE_ERROR (12)
1070 /// The medium in the device has changed since the last
1073 #define RETURN_MEDIA_CHANGED ENCODE_ERROR (13)
1076 /// The item was not found.
1078 #define RETURN_NOT_FOUND ENCODE_ERROR (14)
1081 /// Access was denied.
1083 #define RETURN_ACCESS_DENIED ENCODE_ERROR (15)
1086 /// The server was not found or did not respond to the request.
1088 #define RETURN_NO_RESPONSE ENCODE_ERROR (16)
1091 /// A mapping to the device does not exist.
1093 #define RETURN_NO_MAPPING ENCODE_ERROR (17)
1096 /// A timeout time expired.
1098 #define RETURN_TIMEOUT ENCODE_ERROR (18)
1101 /// The protocol has not been started.
1103 #define RETURN_NOT_STARTED ENCODE_ERROR (19)
1106 /// The protocol has already been started.
1108 #define RETURN_ALREADY_STARTED ENCODE_ERROR (20)
1111 /// The operation was aborted.
1113 #define RETURN_ABORTED ENCODE_ERROR (21)
1116 /// An ICMP error occurred during the network operation.
1118 #define RETURN_ICMP_ERROR ENCODE_ERROR (22)
1121 /// A TFTP error occurred during the network operation.
1123 #define RETURN_TFTP_ERROR ENCODE_ERROR (23)
1126 /// A protocol error occurred during the network operation.
1128 #define RETURN_PROTOCOL_ERROR ENCODE_ERROR (24)
1131 /// A function encountered an internal version that was
1132 /// incompatible with a version requested by the caller.
1134 #define RETURN_INCOMPATIBLE_VERSION ENCODE_ERROR (25)
1137 /// The function was not performed due to a security violation.
1139 #define RETURN_SECURITY_VIOLATION ENCODE_ERROR (26)
1142 /// A CRC error was detected.
1144 #define RETURN_CRC_ERROR ENCODE_ERROR (27)
1147 /// The beginning or end of media was reached.
1149 #define RETURN_END_OF_MEDIA ENCODE_ERROR (28)
1152 /// The end of the file was reached.
1154 #define RETURN_END_OF_FILE ENCODE_ERROR (31)
1157 /// The language specified was invalid.
1159 #define RETURN_INVALID_LANGUAGE ENCODE_ERROR (32)
1162 /// The security status of the data is unknown or compromised
1163 /// and the data must be updated or replaced to restore a valid
1164 /// security status.
1166 #define RETURN_COMPROMISED_DATA ENCODE_ERROR (33)
1169 /// A HTTP error occurred during the network operation.
1171 #define RETURN_HTTP_ERROR ENCODE_ERROR (35)
1174 /// The string contained one or more characters that
1175 /// the device could not render and were skipped.
1177 #define RETURN_WARN_UNKNOWN_GLYPH ENCODE_WARNING (1)
1180 /// The handle was closed, but the file was not deleted.
1182 #define RETURN_WARN_DELETE_FAILURE ENCODE_WARNING (2)
1185 /// The handle was closed, but the data to the file was not
1186 /// flushed properly.
1188 #define RETURN_WARN_WRITE_FAILURE ENCODE_WARNING (3)
1191 /// The resulting buffer was too small, and the data was
1192 /// truncated to the buffer size.
1194 #define RETURN_WARN_BUFFER_TOO_SMALL ENCODE_WARNING (4)
1197 /// The data has not been updated within the timeframe set by
1198 /// local policy for this type of data.
1200 #define RETURN_WARN_STALE_DATA ENCODE_WARNING (5)
1203 /// The resulting buffer contains UEFI-compliant file system.
1205 #define RETURN_WARN_FILE_SYSTEM ENCODE_WARNING (6)
1208 Returns a 16-bit signature built from 2 ASCII characters.
1210 This macro returns a 16-bit value built from the two ASCII characters specified
1213 @param A The first ASCII character.
1214 @param B The second ASCII character.
1216 @return A 16-bit value built from the two ASCII characters specified by A and B.
1219 #define SIGNATURE_16(A, B) ((A) | (B << 8))
1222 Returns a 32-bit signature built from 4 ASCII characters.
1224 This macro returns a 32-bit value built from the four ASCII characters specified
1227 @param A The first ASCII character.
1228 @param B The second ASCII character.
1229 @param C The third ASCII character.
1230 @param D The fourth ASCII character.
1232 @return A 32-bit value built from the two ASCII characters specified by A, B,
1236 #define SIGNATURE_32(A, B, C, D) (SIGNATURE_16 (A, B) | (SIGNATURE_16 (C, D) << 16))
1239 Returns a 64-bit signature built from 8 ASCII characters.
1241 This macro returns a 64-bit value built from the eight ASCII characters specified
1242 by A, B, C, D, E, F, G,and H.
1244 @param A The first ASCII character.
1245 @param B The second ASCII character.
1246 @param C The third ASCII character.
1247 @param D The fourth ASCII character.
1248 @param E The fifth ASCII character.
1249 @param F The sixth ASCII character.
1250 @param G The seventh ASCII character.
1251 @param H The eighth ASCII character.
1253 @return A 64-bit value built from the two ASCII characters specified by A, B,
1254 C, D, E, F, G and H.
1257 #define SIGNATURE_64(A, B, C, D, E, F, G, H) \
1258 (SIGNATURE_32 (A, B, C, D) | ((UINT64) (SIGNATURE_32 (E, F, G, H)) << 32))
1260 #if defined (_MSC_EXTENSIONS) && !defined (__INTEL_COMPILER) && !defined (MDE_CPU_EBC)
1266 #pragma intrinsic(_ReturnAddress)
1269 Get the return address of the calling function.
1271 Based on intrinsic function _ReturnAddress that provides the address of
1272 the instruction in the calling function that will be executed after
1273 control returns to the caller.
1275 @param L Return Level.
1277 @return The return address of the calling function or 0 if L != 0.
1280 #define RETURN_ADDRESS(L) ((L == 0) ? _ReturnAddress() : (VOID *) 0)
1281 #elif defined (__GNUC__) || defined (__clang__)
1284 Get the return address of the calling function.
1286 Based on built-in Function __builtin_return_address that returns
1287 the return address of the current function, or of one of its callers.
1289 @param L Return Level.
1291 @return The return address of the calling function.
1294 #define RETURN_ADDRESS(L) __builtin_return_address (L)
1298 Get the return address of the calling function.
1300 @param L Return Level.
1302 @return 0 as compilers don't support this feature.
1305 #define RETURN_ADDRESS(L) ((VOID *) 0)
1309 Return the number of elements in an array.
1311 @param Array An object of array type. Array is only used as an argument to
1312 the sizeof operator, therefore Array is never evaluated. The
1313 caller is responsible for ensuring that Array's type is not
1314 incomplete; that is, Array must have known constant size.
1316 @return The number of elements in Array. The result has type UINTN.
1319 #define ARRAY_SIZE(Array) (sizeof (Array) / sizeof ((Array)[0]))