123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272 |
- /** @file
- Root include file for Mde Package Base type modules
-
- This is the include file for any module of type base. Base modules only use
- types defined via this include file and can be ported easily to any
- environment. There are a set of base libraries in the Mde Package that can
- be used to implement base modules.
-
- Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>
- Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>
- This program and the accompanying materials
- are licensed and made available under the terms and conditions of the BSD License
- which accompanies this distribution. The full text of the license may be found at
- http://opensource.org/licenses/bsd-license.php.
-
- THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
- WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
-
- **/
-
-
- #ifndef __BASE_H__
- #define __BASE_H__
-
- FILE_LICENCE ( BSD3 );
-
- //
- // Include processor specific binding
- //
- #include <ipxe/efi/ProcessorBind.h>
-
- #if defined(_MSC_EXTENSIONS)
- //
- // Disable warning when last field of data structure is a zero sized array.
- //
- #pragma warning ( disable : 4200 )
- #endif
-
- /**
- Verifies the storage size of a given data type.
-
- This macro generates a divide by zero error or a zero size array declaration in
- the preprocessor if the size is incorrect. These are declared as "extern" so
- the space for these arrays will not be in the modules.
-
- @param TYPE The date type to determine the size of.
- @param Size The expected size for the TYPE.
-
- **/
- #define VERIFY_SIZE_OF(TYPE, Size) extern UINT8 _VerifySizeof##TYPE[(sizeof(TYPE) == (Size)) / (sizeof(TYPE) == (Size))]
-
- //
- // Verify that ProcessorBind.h produced UEFI Data Types that are compliant with
- // Section 2.3.1 of the UEFI 2.3 Specification.
- //
- VERIFY_SIZE_OF (BOOLEAN, 1);
- VERIFY_SIZE_OF (INT8, 1);
- VERIFY_SIZE_OF (UINT8, 1);
- VERIFY_SIZE_OF (INT16, 2);
- VERIFY_SIZE_OF (UINT16, 2);
- VERIFY_SIZE_OF (INT32, 4);
- VERIFY_SIZE_OF (UINT32, 4);
- VERIFY_SIZE_OF (INT64, 8);
- VERIFY_SIZE_OF (UINT64, 8);
- VERIFY_SIZE_OF (CHAR8, 1);
- VERIFY_SIZE_OF (CHAR16, 2);
-
- //
- // The following three enum types are used to verify that the compiler
- // configuration for enum types is compliant with Section 2.3.1 of the
- // UEFI 2.3 Specification. These enum types and enum values are not
- // intended to be used. A prefix of '__' is used avoid conflicts with
- // other types.
- //
- typedef enum {
- __VerifyUint8EnumValue = 0xff
- } __VERIFY_UINT8_ENUM_SIZE;
-
- typedef enum {
- __VerifyUint16EnumValue = 0xffff
- } __VERIFY_UINT16_ENUM_SIZE;
-
- typedef enum {
- __VerifyUint32EnumValue = 0xffffffff
- } __VERIFY_UINT32_ENUM_SIZE;
-
- VERIFY_SIZE_OF (__VERIFY_UINT8_ENUM_SIZE, 4);
- VERIFY_SIZE_OF (__VERIFY_UINT16_ENUM_SIZE, 4);
- VERIFY_SIZE_OF (__VERIFY_UINT32_ENUM_SIZE, 4);
-
- //
- // The Microsoft* C compiler can removed references to unreferenced data items
- // if the /OPT:REF linker option is used. We defined a macro as this is a
- // a non standard extension
- //
- #if defined(_MSC_EXTENSIONS) && !defined (MDE_CPU_EBC)
- ///
- /// Remove global variable from the linked image if there are no references to
- /// it after all compiler and linker optimizations have been performed.
- ///
- ///
- #define GLOBAL_REMOVE_IF_UNREFERENCED __declspec(selectany)
- #else
- ///
- /// Remove the global variable from the linked image if there are no references
- /// to it after all compiler and linker optimizations have been performed.
- ///
- ///
- #define GLOBAL_REMOVE_IF_UNREFERENCED
- #endif
-
- //
- // Should be used in combination with NORETURN to avoid 'noreturn' returns
- // warnings.
- //
- #ifndef UNREACHABLE
- #if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ > 4)
- ///
- /// Signal compilers and analyzers that this call is not reachable. It is
- /// up to the compiler to remove any code past that point.
- /// Not implemented by GCC 4.4 or earlier.
- ///
- #define UNREACHABLE() __builtin_unreachable ()
- #elif defined (__has_feature)
- #if __has_builtin (__builtin_unreachable)
- ///
- /// Signal compilers and analyzers that this call is not reachable. It is
- /// up to the compiler to remove any code past that point.
- ///
- #define UNREACHABLE() __builtin_unreachable ()
- #endif
- #endif
-
- #ifndef UNREACHABLE
- ///
- /// Signal compilers and analyzers that this call is not reachable. It is
- /// up to the compiler to remove any code past that point.
- ///
- #define UNREACHABLE()
- #endif
- #endif
-
- //
- // Signaling compilers and analyzers that a certain function cannot return may
- // remove all following code and thus lead to better optimization and less
- // false positives.
- //
- #ifndef NORETURN
- #if defined (__GNUC__) || defined (__clang__)
- ///
- /// Signal compilers and analyzers that the function cannot return.
- /// It is up to the compiler to remove any code past a call to functions
- /// flagged with this attribute.
- ///
- #define NORETURN __attribute__((noreturn))
- #elif defined(_MSC_EXTENSIONS) && !defined(MDE_CPU_EBC)
- ///
- /// Signal compilers and analyzers that the function cannot return.
- /// It is up to the compiler to remove any code past a call to functions
- /// flagged with this attribute.
- ///
- #define NORETURN __declspec(noreturn)
- #else
- ///
- /// Signal compilers and analyzers that the function cannot return.
- /// It is up to the compiler to remove any code past a call to functions
- /// flagged with this attribute.
- ///
- #define NORETURN
- #endif
- #endif
-
- //
- // Should be used in combination with ANALYZER_NORETURN to avoid 'noreturn'
- // returns warnings.
- //
- #ifndef ANALYZER_UNREACHABLE
- #ifdef __clang_analyzer__
- #if __has_builtin (__builtin_unreachable)
- ///
- /// Signal the analyzer that this call is not reachable.
- /// This excludes compilers.
- ///
- #define ANALYZER_UNREACHABLE() __builtin_unreachable ()
- #endif
- #endif
-
- #ifndef ANALYZER_UNREACHABLE
- ///
- /// Signal the analyzer that this call is not reachable.
- /// This excludes compilers.
- ///
- #define ANALYZER_UNREACHABLE()
- #endif
- #endif
-
- //
- // Static Analyzers may issue errors about potential NULL-dereferences when
- // dereferencing a pointer, that has been checked before, outside of a
- // NULL-check. This may lead to false positives, such as when using ASSERT()
- // for verification.
- //
- #ifndef ANALYZER_NORETURN
- #ifdef __has_feature
- #if __has_feature (attribute_analyzer_noreturn)
- ///
- /// Signal analyzers that the function cannot return.
- /// This excludes compilers.
- ///
- #define ANALYZER_NORETURN __attribute__((analyzer_noreturn))
- #endif
- #endif
-
- #ifndef ANALYZER_NORETURN
- ///
- /// Signal the analyzer that the function cannot return.
- /// This excludes compilers.
- ///
- #define ANALYZER_NORETURN
- #endif
- #endif
-
- //
- // For symbol name in assembly code, an extra "_" is sometimes necessary
- //
-
- ///
- /// Private worker functions for ASM_PFX()
- ///
- #define _CONCATENATE(a, b) __CONCATENATE(a, b)
- #define __CONCATENATE(a, b) a ## b
-
- ///
- /// The __USER_LABEL_PREFIX__ macro predefined by GNUC represents the prefix
- /// on symbols in assembly language.
- ///
- #define ASM_PFX(name) _CONCATENATE (__USER_LABEL_PREFIX__, name)
-
- #if __APPLE__
- //
- // Apple extension that is used by the linker to optimize code size
- // with assembly functions. Put at the end of your .S files
- //
- #define ASM_FUNCTION_REMOVE_IF_UNREFERENCED .subsections_via_symbols
- #else
- #define ASM_FUNCTION_REMOVE_IF_UNREFERENCED
- #endif
-
- #ifdef __CC_ARM
- //
- // Older RVCT ARM compilers don't fully support #pragma pack and require __packed
- // as a prefix for the structure.
- //
- #define PACKED __packed
- #else
- #define PACKED
- #endif
-
- ///
- /// 128 bit buffer containing a unique identifier value.
- /// Unless otherwise specified, aligned on a 64 bit boundary.
- ///
- typedef struct {
- UINT32 Data1;
- UINT16 Data2;
- UINT16 Data3;
- UINT8 Data4[8];
- } GUID;
-
- ///
- /// 4-byte buffer. An IPv4 internet protocol address.
- ///
- typedef struct {
- UINT8 Addr[4];
- } IPv4_ADDRESS;
-
- ///
- /// 16-byte buffer. An IPv6 internet protocol address.
- ///
- typedef struct {
- UINT8 Addr[16];
- } IPv6_ADDRESS;
-
- //
- // 8-bytes unsigned value that represents a physical system address.
- //
- typedef UINT64 PHYSICAL_ADDRESS;
-
- ///
- /// LIST_ENTRY structure definition.
- ///
- typedef struct _LIST_ENTRY LIST_ENTRY;
-
- ///
- /// _LIST_ENTRY structure definition.
- ///
- struct _LIST_ENTRY {
- LIST_ENTRY *ForwardLink;
- LIST_ENTRY *BackLink;
- };
-
- //
- // Modifiers to abstract standard types to aid in debug of problems
- //
-
- ///
- /// Datum is read-only.
- ///
- #define CONST const
-
- ///
- /// Datum is scoped to the current file or function.
- ///
- #define STATIC static
-
- ///
- /// Undeclared type.
- ///
- #define VOID void
-
- //
- // Modifiers for Data Types used to self document code.
- // This concept is borrowed for UEFI specification.
- //
-
- ///
- /// Datum is passed to the function.
- ///
- #define IN
-
- ///
- /// Datum is returned from the function.
- ///
- #define OUT
-
- ///
- /// Passing the datum to the function is optional, and a NULL
- /// is passed if the value is not supplied.
- ///
- #define OPTIONAL
-
- //
- // UEFI specification claims 1 and 0. We are concerned about the
- // compiler portability so we did it this way.
- //
-
- ///
- /// Boolean true value. UEFI Specification defines this value to be 1,
- /// but this form is more portable.
- ///
- #define TRUE ((BOOLEAN)(1==1))
-
- ///
- /// Boolean false value. UEFI Specification defines this value to be 0,
- /// but this form is more portable.
- ///
- #define FALSE ((BOOLEAN)(0==1))
-
- ///
- /// NULL pointer (VOID *)
- ///
- #define NULL ((VOID *) 0)
-
- //
- // Null character
- //
- #define CHAR_NULL 0x0000
-
- ///
- /// Maximum values for common UEFI Data Types
- ///
- #define MAX_INT8 ((INT8)0x7F)
- #define MAX_UINT8 ((UINT8)0xFF)
- #define MAX_INT16 ((INT16)0x7FFF)
- #define MAX_UINT16 ((UINT16)0xFFFF)
- #define MAX_INT32 ((INT32)0x7FFFFFFF)
- #define MAX_UINT32 ((UINT32)0xFFFFFFFF)
- #define MAX_INT64 ((INT64)0x7FFFFFFFFFFFFFFFULL)
- #define MAX_UINT64 ((UINT64)0xFFFFFFFFFFFFFFFFULL)
-
- #define BIT0 0x00000001
- #define BIT1 0x00000002
- #define BIT2 0x00000004
- #define BIT3 0x00000008
- #define BIT4 0x00000010
- #define BIT5 0x00000020
- #define BIT6 0x00000040
- #define BIT7 0x00000080
- #define BIT8 0x00000100
- #define BIT9 0x00000200
- #define BIT10 0x00000400
- #define BIT11 0x00000800
- #define BIT12 0x00001000
- #define BIT13 0x00002000
- #define BIT14 0x00004000
- #define BIT15 0x00008000
- #define BIT16 0x00010000
- #define BIT17 0x00020000
- #define BIT18 0x00040000
- #define BIT19 0x00080000
- #define BIT20 0x00100000
- #define BIT21 0x00200000
- #define BIT22 0x00400000
- #define BIT23 0x00800000
- #define BIT24 0x01000000
- #define BIT25 0x02000000
- #define BIT26 0x04000000
- #define BIT27 0x08000000
- #define BIT28 0x10000000
- #define BIT29 0x20000000
- #define BIT30 0x40000000
- #define BIT31 0x80000000
- #define BIT32 0x0000000100000000ULL
- #define BIT33 0x0000000200000000ULL
- #define BIT34 0x0000000400000000ULL
- #define BIT35 0x0000000800000000ULL
- #define BIT36 0x0000001000000000ULL
- #define BIT37 0x0000002000000000ULL
- #define BIT38 0x0000004000000000ULL
- #define BIT39 0x0000008000000000ULL
- #define BIT40 0x0000010000000000ULL
- #define BIT41 0x0000020000000000ULL
- #define BIT42 0x0000040000000000ULL
- #define BIT43 0x0000080000000000ULL
- #define BIT44 0x0000100000000000ULL
- #define BIT45 0x0000200000000000ULL
- #define BIT46 0x0000400000000000ULL
- #define BIT47 0x0000800000000000ULL
- #define BIT48 0x0001000000000000ULL
- #define BIT49 0x0002000000000000ULL
- #define BIT50 0x0004000000000000ULL
- #define BIT51 0x0008000000000000ULL
- #define BIT52 0x0010000000000000ULL
- #define BIT53 0x0020000000000000ULL
- #define BIT54 0x0040000000000000ULL
- #define BIT55 0x0080000000000000ULL
- #define BIT56 0x0100000000000000ULL
- #define BIT57 0x0200000000000000ULL
- #define BIT58 0x0400000000000000ULL
- #define BIT59 0x0800000000000000ULL
- #define BIT60 0x1000000000000000ULL
- #define BIT61 0x2000000000000000ULL
- #define BIT62 0x4000000000000000ULL
- #define BIT63 0x8000000000000000ULL
-
- #define SIZE_1KB 0x00000400
- #define SIZE_2KB 0x00000800
- #define SIZE_4KB 0x00001000
- #define SIZE_8KB 0x00002000
- #define SIZE_16KB 0x00004000
- #define SIZE_32KB 0x00008000
- #define SIZE_64KB 0x00010000
- #define SIZE_128KB 0x00020000
- #define SIZE_256KB 0x00040000
- #define SIZE_512KB 0x00080000
- #define SIZE_1MB 0x00100000
- #define SIZE_2MB 0x00200000
- #define SIZE_4MB 0x00400000
- #define SIZE_8MB 0x00800000
- #define SIZE_16MB 0x01000000
- #define SIZE_32MB 0x02000000
- #define SIZE_64MB 0x04000000
- #define SIZE_128MB 0x08000000
- #define SIZE_256MB 0x10000000
- #define SIZE_512MB 0x20000000
- #define SIZE_1GB 0x40000000
- #define SIZE_2GB 0x80000000
- #define SIZE_4GB 0x0000000100000000ULL
- #define SIZE_8GB 0x0000000200000000ULL
- #define SIZE_16GB 0x0000000400000000ULL
- #define SIZE_32GB 0x0000000800000000ULL
- #define SIZE_64GB 0x0000001000000000ULL
- #define SIZE_128GB 0x0000002000000000ULL
- #define SIZE_256GB 0x0000004000000000ULL
- #define SIZE_512GB 0x0000008000000000ULL
- #define SIZE_1TB 0x0000010000000000ULL
- #define SIZE_2TB 0x0000020000000000ULL
- #define SIZE_4TB 0x0000040000000000ULL
- #define SIZE_8TB 0x0000080000000000ULL
- #define SIZE_16TB 0x0000100000000000ULL
- #define SIZE_32TB 0x0000200000000000ULL
- #define SIZE_64TB 0x0000400000000000ULL
- #define SIZE_128TB 0x0000800000000000ULL
- #define SIZE_256TB 0x0001000000000000ULL
- #define SIZE_512TB 0x0002000000000000ULL
- #define SIZE_1PB 0x0004000000000000ULL
- #define SIZE_2PB 0x0008000000000000ULL
- #define SIZE_4PB 0x0010000000000000ULL
- #define SIZE_8PB 0x0020000000000000ULL
- #define SIZE_16PB 0x0040000000000000ULL
- #define SIZE_32PB 0x0080000000000000ULL
- #define SIZE_64PB 0x0100000000000000ULL
- #define SIZE_128PB 0x0200000000000000ULL
- #define SIZE_256PB 0x0400000000000000ULL
- #define SIZE_512PB 0x0800000000000000ULL
- #define SIZE_1EB 0x1000000000000000ULL
- #define SIZE_2EB 0x2000000000000000ULL
- #define SIZE_4EB 0x4000000000000000ULL
- #define SIZE_8EB 0x8000000000000000ULL
-
- #define BASE_1KB 0x00000400
- #define BASE_2KB 0x00000800
- #define BASE_4KB 0x00001000
- #define BASE_8KB 0x00002000
- #define BASE_16KB 0x00004000
- #define BASE_32KB 0x00008000
- #define BASE_64KB 0x00010000
- #define BASE_128KB 0x00020000
- #define BASE_256KB 0x00040000
- #define BASE_512KB 0x00080000
- #define BASE_1MB 0x00100000
- #define BASE_2MB 0x00200000
- #define BASE_4MB 0x00400000
- #define BASE_8MB 0x00800000
- #define BASE_16MB 0x01000000
- #define BASE_32MB 0x02000000
- #define BASE_64MB 0x04000000
- #define BASE_128MB 0x08000000
- #define BASE_256MB 0x10000000
- #define BASE_512MB 0x20000000
- #define BASE_1GB 0x40000000
- #define BASE_2GB 0x80000000
- #define BASE_4GB 0x0000000100000000ULL
- #define BASE_8GB 0x0000000200000000ULL
- #define BASE_16GB 0x0000000400000000ULL
- #define BASE_32GB 0x0000000800000000ULL
- #define BASE_64GB 0x0000001000000000ULL
- #define BASE_128GB 0x0000002000000000ULL
- #define BASE_256GB 0x0000004000000000ULL
- #define BASE_512GB 0x0000008000000000ULL
- #define BASE_1TB 0x0000010000000000ULL
- #define BASE_2TB 0x0000020000000000ULL
- #define BASE_4TB 0x0000040000000000ULL
- #define BASE_8TB 0x0000080000000000ULL
- #define BASE_16TB 0x0000100000000000ULL
- #define BASE_32TB 0x0000200000000000ULL
- #define BASE_64TB 0x0000400000000000ULL
- #define BASE_128TB 0x0000800000000000ULL
- #define BASE_256TB 0x0001000000000000ULL
- #define BASE_512TB 0x0002000000000000ULL
- #define BASE_1PB 0x0004000000000000ULL
- #define BASE_2PB 0x0008000000000000ULL
- #define BASE_4PB 0x0010000000000000ULL
- #define BASE_8PB 0x0020000000000000ULL
- #define BASE_16PB 0x0040000000000000ULL
- #define BASE_32PB 0x0080000000000000ULL
- #define BASE_64PB 0x0100000000000000ULL
- #define BASE_128PB 0x0200000000000000ULL
- #define BASE_256PB 0x0400000000000000ULL
- #define BASE_512PB 0x0800000000000000ULL
- #define BASE_1EB 0x1000000000000000ULL
- #define BASE_2EB 0x2000000000000000ULL
- #define BASE_4EB 0x4000000000000000ULL
- #define BASE_8EB 0x8000000000000000ULL
-
- //
- // Support for variable length argument lists using the ANSI standard.
- //
- // Since we are using the ANSI standard we used the standard naming and
- // did not follow the coding convention
- //
- // VA_LIST - typedef for argument list.
- // VA_START (VA_LIST Marker, argument before the ...) - Init Marker for use.
- // VA_END (VA_LIST Marker) - Clear Marker
- // VA_ARG (VA_LIST Marker, var arg size) - Use Marker to get an argument from
- // the ... list. You must know the size and pass it in this macro.
- // VA_COPY (VA_LIST Dest, VA_LIST Start) - Initialize Dest as a copy of Start.
- //
- // example:
- //
- // UINTN
- // ExampleVarArg (
- // IN UINTN NumberOfArgs,
- // ...
- // )
- // {
- // VA_LIST Marker;
- // UINTN Index;
- // UINTN Result;
- //
- // //
- // // Initialize the Marker
- // //
- // VA_START (Marker, NumberOfArgs);
- // for (Index = 0, Result = 0; Index < NumberOfArgs; Index++) {
- // //
- // // The ... list is a series of UINTN values, so average them up.
- // //
- // Result += VA_ARG (Marker, UINTN);
- // }
- //
- // VA_END (Marker);
- // return Result
- // }
- //
-
- /**
- Return the size of argument that has been aligned to sizeof (UINTN).
-
- @param n The parameter size to be aligned.
-
- @return The aligned size.
- **/
- #define _INT_SIZE_OF(n) ((sizeof (n) + sizeof (UINTN) - 1) &~(sizeof (UINTN) - 1))
-
- #if defined(__CC_ARM)
- //
- // RVCT ARM variable argument list support.
- //
-
- ///
- /// Variable used to traverse the list of arguments. This type can vary by
- /// implementation and could be an array or structure.
- ///
- #ifdef __APCS_ADSABI
- typedef int *va_list[1];
- #define VA_LIST va_list
- #else
- typedef struct __va_list { void *__ap; } va_list;
- #define VA_LIST va_list
- #endif
-
- #define VA_START(Marker, Parameter) __va_start(Marker, Parameter)
-
- #define VA_ARG(Marker, TYPE) __va_arg(Marker, TYPE)
-
- #define VA_END(Marker) ((void)0)
-
- // For some ARM RVCT compilers, __va_copy is not defined
- #ifndef __va_copy
- #define __va_copy(dest, src) ((void)((dest) = (src)))
- #endif
-
- #define VA_COPY(Dest, Start) __va_copy (Dest, Start)
-
- #elif defined(__GNUC__)
-
- #if defined(MDE_CPU_X64) && !defined(NO_MSABI_VA_FUNCS)
- //
- // X64 only. Use MS ABI version of GCC built-in macros for variable argument lists.
- //
- ///
- /// Both GCC and LLVM 3.8 for X64 support new variable argument intrinsics for Microsoft ABI
- ///
-
- ///
- /// Variable used to traverse the list of arguments. This type can vary by
- /// implementation and could be an array or structure.
- ///
- typedef __builtin_ms_va_list VA_LIST;
-
- #define VA_START(Marker, Parameter) __builtin_ms_va_start (Marker, Parameter)
-
- #define VA_ARG(Marker, TYPE) ((sizeof (TYPE) < sizeof (UINTN)) ? (TYPE)(__builtin_va_arg (Marker, UINTN)) : (TYPE)(__builtin_va_arg (Marker, TYPE)))
-
- #define VA_END(Marker) __builtin_ms_va_end (Marker)
-
- #define VA_COPY(Dest, Start) __builtin_ms_va_copy (Dest, Start)
-
- #else
- //
- // Use GCC built-in macros for variable argument lists.
- //
-
- ///
- /// Variable used to traverse the list of arguments. This type can vary by
- /// implementation and could be an array or structure.
- ///
- typedef __builtin_va_list VA_LIST;
-
- #define VA_START(Marker, Parameter) __builtin_va_start (Marker, Parameter)
-
- #define VA_ARG(Marker, TYPE) ((sizeof (TYPE) < sizeof (UINTN)) ? (TYPE)(__builtin_va_arg (Marker, UINTN)) : (TYPE)(__builtin_va_arg (Marker, TYPE)))
-
- #define VA_END(Marker) __builtin_va_end (Marker)
-
- #define VA_COPY(Dest, Start) __builtin_va_copy (Dest, Start)
-
- #endif
-
- #else
- ///
- /// Variable used to traverse the list of arguments. This type can vary by
- /// implementation and could be an array or structure.
- ///
- typedef CHAR8 *VA_LIST;
-
- /**
- Retrieves a pointer to the beginning of a variable argument list, based on
- the name of the parameter that immediately precedes the variable argument list.
-
- This function initializes Marker to point to the beginning of the variable
- argument list that immediately follows Parameter. The method for computing the
- pointer to the next argument in the argument list is CPU-specific following the
- EFIAPI ABI.
-
- @param Marker The VA_LIST used to traverse the list of arguments.
- @param Parameter The name of the parameter that immediately precedes
- the variable argument list.
-
- @return A pointer to the beginning of a variable argument list.
-
- **/
- #define VA_START(Marker, Parameter) (Marker = (VA_LIST) ((UINTN) & (Parameter) + _INT_SIZE_OF (Parameter)))
-
- /**
- Returns an argument of a specified type from a variable argument list and updates
- the pointer to the variable argument list to point to the next argument.
-
- This function returns an argument of the type specified by TYPE from the beginning
- of the variable argument list specified by Marker. Marker is then updated to point
- to the next argument in the variable argument list. The method for computing the
- pointer to the next argument in the argument list is CPU-specific following the EFIAPI ABI.
-
- @param Marker VA_LIST used to traverse the list of arguments.
- @param TYPE The type of argument to retrieve from the beginning
- of the variable argument list.
-
- @return An argument of the type specified by TYPE.
-
- **/
- #define VA_ARG(Marker, TYPE) (*(TYPE *) ((Marker += _INT_SIZE_OF (TYPE)) - _INT_SIZE_OF (TYPE)))
-
- /**
- Terminates the use of a variable argument list.
-
- This function initializes Marker so it can no longer be used with VA_ARG().
- After this macro is used, the only way to access the variable argument list is
- by using VA_START() again.
-
- @param Marker VA_LIST used to traverse the list of arguments.
-
- **/
- #define VA_END(Marker) (Marker = (VA_LIST) 0)
-
- /**
- Initializes a VA_LIST as a copy of an existing VA_LIST.
-
- This macro initializes Dest as a copy of Start, as if the VA_START macro had been applied to Dest
- followed by the same sequence of uses of the VA_ARG macro as had previously been used to reach
- the present state of Start.
-
- @param Dest VA_LIST used to traverse the list of arguments.
- @param Start VA_LIST used to traverse the list of arguments.
-
- **/
- #define VA_COPY(Dest, Start) ((void)((Dest) = (Start)))
-
- #endif
-
- ///
- /// Pointer to the start of a variable argument list stored in a memory buffer. Same as UINT8 *.
- ///
- typedef UINTN *BASE_LIST;
-
- /**
- Returns the size of a data type in sizeof(UINTN) units rounded up to the nearest UINTN boundary.
-
- @param TYPE The date type to determine the size of.
-
- @return The size of TYPE in sizeof (UINTN) units rounded up to the nearest UINTN boundary.
- **/
- #define _BASE_INT_SIZE_OF(TYPE) ((sizeof (TYPE) + sizeof (UINTN) - 1) / sizeof (UINTN))
-
- /**
- Returns an argument of a specified type from a variable argument list and updates
- the pointer to the variable argument list to point to the next argument.
-
- This function returns an argument of the type specified by TYPE from the beginning
- of the variable argument list specified by Marker. Marker is then updated to point
- to the next argument in the variable argument list. The method for computing the
- pointer to the next argument in the argument list is CPU specific following the EFIAPI ABI.
-
- @param Marker The pointer to the beginning of a variable argument list.
- @param TYPE The type of argument to retrieve from the beginning
- of the variable argument list.
-
- @return An argument of the type specified by TYPE.
-
- **/
- #define BASE_ARG(Marker, TYPE) (*(TYPE *) ((Marker += _BASE_INT_SIZE_OF (TYPE)) - _BASE_INT_SIZE_OF (TYPE)))
-
- /**
- The macro that returns the byte offset of a field in a data structure.
-
- This function returns the offset, in bytes, of field specified by Field from the
- beginning of the data structure specified by TYPE. If TYPE does not contain Field,
- the module will not compile.
-
- @param TYPE The name of the data structure that contains the field specified by Field.
- @param Field The name of the field in the data structure.
-
- @return Offset, in bytes, of field.
-
- **/
- #ifdef __GNUC__
- #if __GNUC__ >= 4
- #define OFFSET_OF(TYPE, Field) ((UINTN) __builtin_offsetof(TYPE, Field))
- #endif
- #endif
-
- #ifndef OFFSET_OF
- #define OFFSET_OF(TYPE, Field) ((UINTN) &(((TYPE *)0)->Field))
- #endif
-
- /**
- Macro that returns a pointer to the data structure that contains a specified field of
- that data structure. This is a lightweight method to hide information by placing a
- public data structure inside a larger private data structure and using a pointer to
- the public data structure to retrieve a pointer to the private data structure.
-
- This function computes the offset, in bytes, of field specified by Field from the beginning
- of the data structure specified by TYPE. This offset is subtracted from Record, and is
- used to return a pointer to a data structure of the type specified by TYPE. If the data type
- specified by TYPE does not contain the field specified by Field, then the module will not compile.
-
- @param Record Pointer to the field specified by Field within a data structure of type TYPE.
- @param TYPE The name of the data structure type to return. This data structure must
- contain the field specified by Field.
- @param Field The name of the field in the data structure specified by TYPE to which Record points.
-
- @return A pointer to the structure from one of it's elements.
-
- **/
- #define BASE_CR(Record, TYPE, Field) ((TYPE *) ((CHAR8 *) (Record) - (CHAR8 *) &(((TYPE *) 0)->Field)))
-
- /**
- Rounds a value up to the next boundary using a specified alignment.
-
- This function rounds Value up to the next boundary using the specified Alignment.
- This aligned value is returned.
-
- @param Value The value to round up.
- @param Alignment The alignment boundary used to return the aligned value.
-
- @return A value up to the next boundary.
-
- **/
- #define ALIGN_VALUE(Value, Alignment) ((Value) + (((Alignment) - (Value)) & ((Alignment) - 1)))
-
- /**
- Adjust a pointer by adding the minimum offset required for it to be aligned on
- a specified alignment boundary.
-
- This function rounds the pointer specified by Pointer to the next alignment boundary
- specified by Alignment. The pointer to the aligned address is returned.
-
- @param Pointer The pointer to round up.
- @param Alignment The alignment boundary to use to return an aligned pointer.
-
- @return Pointer to the aligned address.
-
- **/
- #define ALIGN_POINTER(Pointer, Alignment) ((VOID *) (ALIGN_VALUE ((UINTN)(Pointer), (Alignment))))
-
- /**
- Rounds a value up to the next natural boundary for the current CPU.
- This is 4-bytes for 32-bit CPUs and 8-bytes for 64-bit CPUs.
-
- This function rounds the value specified by Value up to the next natural boundary for the
- current CPU. This rounded value is returned.
-
- @param Value The value to round up.
-
- @return Rounded value specified by Value.
-
- **/
- #define ALIGN_VARIABLE(Value) ALIGN_VALUE ((Value), sizeof (UINTN))
-
-
- /**
- Return the maximum of two operands.
-
- This macro returns the maximum of two operand specified by a and b.
- Both a and b must be the same numerical types, signed or unsigned.
-
- @param a The first operand with any numerical type.
- @param b The second operand. Can be any numerical type as long as is
- the same type as a.
-
- @return Maximum of two operands.
-
- **/
- #define MAX(a, b) \
- (((a) > (b)) ? (a) : (b))
-
- /**
- Return the minimum of two operands.
-
- This macro returns the minimal of two operand specified by a and b.
- Both a and b must be the same numerical types, signed or unsigned.
-
- @param a The first operand with any numerical type.
- @param b The second operand. It should be the same any numerical type with a.
-
- @return Minimum of two operands.
-
- **/
- #define MIN(a, b) \
- (((a) < (b)) ? (a) : (b))
-
- /**
- Return the absolute value of a signed operand.
-
- This macro returns the absolute value of the signed operand specified by a.
-
- @param a The signed operand.
-
- @return The absolute value of the signed operand.
-
- **/
- #define ABS(a) \
- (((a) < 0) ? (-(a)) : (a))
-
- //
- // Status codes common to all execution phases
- //
- typedef UINTN RETURN_STATUS;
-
- /**
- Produces a RETURN_STATUS code with the highest bit set.
-
- @param StatusCode The status code value to convert into a warning code.
- StatusCode must be in the range 0x00000000..0x7FFFFFFF.
-
- @return The value specified by StatusCode with the highest bit set.
-
- **/
- #define ENCODE_ERROR(StatusCode) ((RETURN_STATUS)(MAX_BIT | (StatusCode)))
-
- /**
- Produces a RETURN_STATUS code with the highest bit clear.
-
- @param StatusCode The status code value to convert into a warning code.
- StatusCode must be in the range 0x00000000..0x7FFFFFFF.
-
- @return The value specified by StatusCode with the highest bit clear.
-
- **/
- #define ENCODE_WARNING(StatusCode) ((RETURN_STATUS)(StatusCode))
-
- /**
- Returns TRUE if a specified RETURN_STATUS code is an error code.
-
- This function returns TRUE if StatusCode has the high bit set. Otherwise, FALSE is returned.
-
- @param StatusCode The status code value to evaluate.
-
- @retval TRUE The high bit of StatusCode is set.
- @retval FALSE The high bit of StatusCode is clear.
-
- **/
- #define RETURN_ERROR(StatusCode) (((INTN)(RETURN_STATUS)(StatusCode)) < 0)
-
- ///
- /// The operation completed successfully.
- ///
- #define RETURN_SUCCESS 0
-
- ///
- /// The image failed to load.
- ///
- #define RETURN_LOAD_ERROR ENCODE_ERROR (1)
-
- ///
- /// The parameter was incorrect.
- ///
- #define RETURN_INVALID_PARAMETER ENCODE_ERROR (2)
-
- ///
- /// The operation is not supported.
- ///
- #define RETURN_UNSUPPORTED ENCODE_ERROR (3)
-
- ///
- /// The buffer was not the proper size for the request.
- ///
- #define RETURN_BAD_BUFFER_SIZE ENCODE_ERROR (4)
-
- ///
- /// The buffer was not large enough to hold the requested data.
- /// The required buffer size is returned in the appropriate
- /// parameter when this error occurs.
- ///
- #define RETURN_BUFFER_TOO_SMALL ENCODE_ERROR (5)
-
- ///
- /// There is no data pending upon return.
- ///
- #define RETURN_NOT_READY ENCODE_ERROR (6)
-
- ///
- /// The physical device reported an error while attempting the
- /// operation.
- ///
- #define RETURN_DEVICE_ERROR ENCODE_ERROR (7)
-
- ///
- /// The device can not be written to.
- ///
- #define RETURN_WRITE_PROTECTED ENCODE_ERROR (8)
-
- ///
- /// The resource has run out.
- ///
- #define RETURN_OUT_OF_RESOURCES ENCODE_ERROR (9)
-
- ///
- /// An inconsistency was detected on the file system causing the
- /// operation to fail.
- ///
- #define RETURN_VOLUME_CORRUPTED ENCODE_ERROR (10)
-
- ///
- /// There is no more space on the file system.
- ///
- #define RETURN_VOLUME_FULL ENCODE_ERROR (11)
-
- ///
- /// The device does not contain any medium to perform the
- /// operation.
- ///
- #define RETURN_NO_MEDIA ENCODE_ERROR (12)
-
- ///
- /// The medium in the device has changed since the last
- /// access.
- ///
- #define RETURN_MEDIA_CHANGED ENCODE_ERROR (13)
-
- ///
- /// The item was not found.
- ///
- #define RETURN_NOT_FOUND ENCODE_ERROR (14)
-
- ///
- /// Access was denied.
- ///
- #define RETURN_ACCESS_DENIED ENCODE_ERROR (15)
-
- ///
- /// The server was not found or did not respond to the request.
- ///
- #define RETURN_NO_RESPONSE ENCODE_ERROR (16)
-
- ///
- /// A mapping to the device does not exist.
- ///
- #define RETURN_NO_MAPPING ENCODE_ERROR (17)
-
- ///
- /// A timeout time expired.
- ///
- #define RETURN_TIMEOUT ENCODE_ERROR (18)
-
- ///
- /// The protocol has not been started.
- ///
- #define RETURN_NOT_STARTED ENCODE_ERROR (19)
-
- ///
- /// The protocol has already been started.
- ///
- #define RETURN_ALREADY_STARTED ENCODE_ERROR (20)
-
- ///
- /// The operation was aborted.
- ///
- #define RETURN_ABORTED ENCODE_ERROR (21)
-
- ///
- /// An ICMP error occurred during the network operation.
- ///
- #define RETURN_ICMP_ERROR ENCODE_ERROR (22)
-
- ///
- /// A TFTP error occurred during the network operation.
- ///
- #define RETURN_TFTP_ERROR ENCODE_ERROR (23)
-
- ///
- /// A protocol error occurred during the network operation.
- ///
- #define RETURN_PROTOCOL_ERROR ENCODE_ERROR (24)
-
- ///
- /// A function encountered an internal version that was
- /// incompatible with a version requested by the caller.
- ///
- #define RETURN_INCOMPATIBLE_VERSION ENCODE_ERROR (25)
-
- ///
- /// The function was not performed due to a security violation.
- ///
- #define RETURN_SECURITY_VIOLATION ENCODE_ERROR (26)
-
- ///
- /// A CRC error was detected.
- ///
- #define RETURN_CRC_ERROR ENCODE_ERROR (27)
-
- ///
- /// The beginning or end of media was reached.
- ///
- #define RETURN_END_OF_MEDIA ENCODE_ERROR (28)
-
- ///
- /// The end of the file was reached.
- ///
- #define RETURN_END_OF_FILE ENCODE_ERROR (31)
-
- ///
- /// The language specified was invalid.
- ///
- #define RETURN_INVALID_LANGUAGE ENCODE_ERROR (32)
-
- ///
- /// The security status of the data is unknown or compromised
- /// and the data must be updated or replaced to restore a valid
- /// security status.
- ///
- #define RETURN_COMPROMISED_DATA ENCODE_ERROR (33)
-
- ///
- /// A HTTP error occurred during the network operation.
- ///
- #define RETURN_HTTP_ERROR ENCODE_ERROR (35)
-
- ///
- /// The string contained one or more characters that
- /// the device could not render and were skipped.
- ///
- #define RETURN_WARN_UNKNOWN_GLYPH ENCODE_WARNING (1)
-
- ///
- /// The handle was closed, but the file was not deleted.
- ///
- #define RETURN_WARN_DELETE_FAILURE ENCODE_WARNING (2)
-
- ///
- /// The handle was closed, but the data to the file was not
- /// flushed properly.
- ///
- #define RETURN_WARN_WRITE_FAILURE ENCODE_WARNING (3)
-
- ///
- /// The resulting buffer was too small, and the data was
- /// truncated to the buffer size.
- ///
- #define RETURN_WARN_BUFFER_TOO_SMALL ENCODE_WARNING (4)
-
- ///
- /// The data has not been updated within the timeframe set by
- /// local policy for this type of data.
- ///
- #define RETURN_WARN_STALE_DATA ENCODE_WARNING (5)
-
- ///
- /// The resulting buffer contains UEFI-compliant file system.
- ///
- #define RETURN_WARN_FILE_SYSTEM ENCODE_WARNING (6)
-
-
- /**
- Returns a 16-bit signature built from 2 ASCII characters.
-
- This macro returns a 16-bit value built from the two ASCII characters specified
- by A and B.
-
- @param A The first ASCII character.
- @param B The second ASCII character.
-
- @return A 16-bit value built from the two ASCII characters specified by A and B.
-
- **/
- #define SIGNATURE_16(A, B) ((A) | (B << 8))
-
- /**
- Returns a 32-bit signature built from 4 ASCII characters.
-
- This macro returns a 32-bit value built from the four ASCII characters specified
- by A, B, C, and D.
-
- @param A The first ASCII character.
- @param B The second ASCII character.
- @param C The third ASCII character.
- @param D The fourth ASCII character.
-
- @return A 32-bit value built from the two ASCII characters specified by A, B,
- C and D.
-
- **/
- #define SIGNATURE_32(A, B, C, D) (SIGNATURE_16 (A, B) | (SIGNATURE_16 (C, D) << 16))
-
- /**
- Returns a 64-bit signature built from 8 ASCII characters.
-
- This macro returns a 64-bit value built from the eight ASCII characters specified
- by A, B, C, D, E, F, G,and H.
-
- @param A The first ASCII character.
- @param B The second ASCII character.
- @param C The third ASCII character.
- @param D The fourth ASCII character.
- @param E The fifth ASCII character.
- @param F The sixth ASCII character.
- @param G The seventh ASCII character.
- @param H The eighth ASCII character.
-
- @return A 64-bit value built from the two ASCII characters specified by A, B,
- C, D, E, F, G and H.
-
- **/
- #define SIGNATURE_64(A, B, C, D, E, F, G, H) \
- (SIGNATURE_32 (A, B, C, D) | ((UINT64) (SIGNATURE_32 (E, F, G, H)) << 32))
-
- #if defined(_MSC_EXTENSIONS) && !defined (__INTEL_COMPILER) && !defined (MDE_CPU_EBC)
- #pragma intrinsic(_ReturnAddress)
- /**
- Get the return address of the calling function.
-
- Based on intrinsic function _ReturnAddress that provides the address of
- the instruction in the calling function that will be executed after
- control returns to the caller.
-
- @param L Return Level.
-
- @return The return address of the calling function or 0 if L != 0.
-
- **/
- #define RETURN_ADDRESS(L) ((L == 0) ? _ReturnAddress() : (VOID *) 0)
- #elif defined(__GNUC__)
- void * __builtin_return_address (unsigned int level);
- /**
- Get the return address of the calling function.
-
- Based on built-in Function __builtin_return_address that returns
- the return address of the current function, or of one of its callers.
-
- @param L Return Level.
-
- @return The return address of the calling function.
-
- **/
- #define RETURN_ADDRESS(L) __builtin_return_address (L)
- #else
- /**
- Get the return address of the calling function.
-
- @param L Return Level.
-
- @return 0 as compilers don't support this feature.
-
- **/
- #define RETURN_ADDRESS(L) ((VOID *) 0)
- #endif
-
- /**
- Return the number of elements in an array.
-
- @param Array An object of array type. Array is only used as an argument to
- the sizeof operator, therefore Array is never evaluated. The
- caller is responsible for ensuring that Array's type is not
- incomplete; that is, Array must have known constant size.
-
- @return The number of elements in Array. The result has type UINTN.
-
- **/
- #define ARRAY_SIZE(Array) (sizeof (Array) / sizeof ((Array)[0]))
-
- #endif
|