4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Root include file for Mde Package Base type modules
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This is the include file for any module of type base. Base modules only use
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync types defined via this include file and can be ported easily to any
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync environment. There are a set of base libraries in the Mde Package that can
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync be used to implement base modules.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncCopyright (c) 2006 - 2012, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncPortions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThis program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncare licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncwhich accompanies this distribution. The full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncTHE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncWITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Include processor specific binding
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Verifies the storage size of a given data type.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This macro generates a divide by zero error or a zero size array declaration in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the preprocessor if the size is incorrect. These are declared as "extern" so
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the space for these arrays will not be in the modules.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param TYPE The date type to determine the size of.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Size The expected size for the TYPE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define VERIFY_SIZE_OF(TYPE, Size) extern UINT8 _VerifySizeof##TYPE[(sizeof(TYPE) == (Size)) / (sizeof(TYPE) == (Size))]
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Verify that ProcessorBind.h produced UEFI Data Types that are compliant with
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Section 2.3.1 of the UEFI 2.3 Specification.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// The Microsoft* C compiler can removed references to unreferenced data items
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// if the /OPT:REF linker option is used. We defined a macro as this is a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// a non standard extension
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#if defined(_MSC_EXTENSIONS) && !defined (MDE_CPU_EBC)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Remove global variable from the linked image if there are no references to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// it after all compiler and linker optimizations have been performed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync #define GLOBAL_REMOVE_IF_UNREFERENCED __declspec(selectany)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Remove the global variable from the linked image if there are no references
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// to it after all compiler and linker optimizations have been performed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// For symbol name in GNU assembly code, an extra "_" is necessary
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Private worker functions for ASM_PFX()
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The __USER_LABEL_PREFIX__ macro predefined by GNUC represents the prefix
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// on symbols in assembly language.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync #define ASM_PFX(name) _CONCATENATE (__USER_LABEL_PREFIX__, name)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Apple extension that is used by the linker to optimize code size
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // with assembly functions. Put at the end of your .S files
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync #define ASM_FUNCTION_REMOVE_IF_UNREFERENCED .subsections_via_symbols
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Older RVCT ARM compilers don't fully support #pragma pack and require __packed
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // as a prefix for the structure.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// 128 bit buffer containing a unique identifier value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Unless otherwise specified, aligned on a 64 bit boundary.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// 8-bytes unsigned value that represents a physical system address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// LIST_ENTRY structure definition.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// _LIST_ENTRY structure definition.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Modifiers to abstract standard types to aid in debug of problems
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Datum is read-only.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Datum is scoped to the current file or function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Undeclared type.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Modifiers for Data Types used to self document code.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// This concept is borrowed for UEFI specification.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Datum is passed to the function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Datum is returned from the function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Passing the datum to the function is optional, and a NULL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// is passed if the value is not supplied.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// UEFI specification claims 1 and 0. We are concerned about the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// complier portability so we did it this way.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Boolean true value. UEFI Specification defines this value to be 1,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// but this form is more portable.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Boolean false value. UEFI Specification defines this value to be 0,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// but this form is more portable.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// NULL pointer (VOID *)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Support for variable length argument lists using the ANSI standard.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Since we are using the ANSI standard we used the standard naming and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// did not follow the coding convention
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// VA_LIST - typedef for argument list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// VA_START (VA_LIST Marker, argument before the ...) - Init Marker for use.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// VA_END (VA_LIST Marker) - Clear Marker
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// VA_ARG (VA_LIST Marker, var arg size) - Use Marker to get an argument from
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// the ... list. You must know the size and pass it in this macro.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// VA_COPY (VA_LIST Dest, VA_LIST Start) - Initialize Dest as a copy of Start.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// ExampleVarArg (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// IN UINTN NumberOfArgs,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// VA_LIST Marker;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// UINTN Index;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// UINTN Result;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// // Initialize the Marker
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// VA_START (Marker, NumberOfArgs);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// for (Index = 0, Result = 0; Index < NumberOfArgs; Index++) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// // The ... list is a series of UINTN values, so average them up.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Result += VA_ARG (Marker, UINTN);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// VA_END (Marker);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// return Result
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Return the size of argument that has been aligned to sizeof (UINTN).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param n The parameter size to be aligned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The aligned size.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define _INT_SIZE_OF(n) ((sizeof (n) + sizeof (UINTN) - 1) &~(sizeof (UINTN) - 1))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// RVCT ARM variable argument list support.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Variable used to traverse the list of arguments. This type can vary by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// implementation and could be an array or structure.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define VA_START(Marker, Parameter) __va_start(Marker, Parameter)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define VA_COPY(Dest, Start) __va_copy (Dest, Start)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#elif defined(__GNUC__) && !defined(NO_BUILTIN_VA_FUNCS)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Use GCC built-in macros for variable argument lists.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Variable used to traverse the list of arguments. This type can vary by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// implementation and could be an array or structure.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define VA_START(Marker, Parameter) __builtin_va_start (Marker, Parameter)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define VA_ARG(Marker, TYPE) ((sizeof (TYPE) < sizeof (UINTN)) ? (TYPE)(__builtin_va_arg (Marker, UINTN)) : (TYPE)(__builtin_va_arg (Marker, TYPE)))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define VA_COPY(Dest, Start) __builtin_va_copy (Dest, Start)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Variable used to traverse the list of arguments. This type can vary by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// implementation and could be an array or structure.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Retrieves a pointer to the beginning of a variable argument list, based on
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the name of the parameter that immediately precedes the variable argument list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function initializes Marker to point to the beginning of the variable
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync argument list that immediately follows Parameter. The method for computing the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync pointer to the next argument in the argument list is CPU-specific following the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFIAPI ABI.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Marker The VA_LIST used to traverse the list of arguments.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Parameter The name of the parameter that immediately precedes
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the variable argument list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return A pointer to the beginning of a variable argument list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define VA_START(Marker, Parameter) (Marker = (VA_LIST) ((UINTN) & (Parameter) + _INT_SIZE_OF (Parameter)))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Returns an argument of a specified type from a variable argument list and updates
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the pointer to the variable argument list to point to the next argument.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function returns an argument of the type specified by TYPE from the beginning
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of the variable argument list specified by Marker. Marker is then updated to point
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to the next argument in the variable argument list. The method for computing the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync pointer to the next argument in the argument list is CPU-specific following the EFIAPI ABI.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Marker VA_LIST used to traverse the list of arguments.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param TYPE The type of argument to retrieve from the beginning
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of the variable argument list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return An argument of the type specified by TYPE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define VA_ARG(Marker, TYPE) (*(TYPE *) ((Marker += _INT_SIZE_OF (TYPE)) - _INT_SIZE_OF (TYPE)))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Terminates the use of a variable argument list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function initializes Marker so it can no longer be used with VA_ARG().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync After this macro is used, the only way to access the variable argument list is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync by using VA_START() again.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Marker VA_LIST used to traverse the list of arguments.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Initializes a VA_LIST as a copy of an existing VA_LIST.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This macro initializes Dest as a copy of Start, as if the VA_START macro had been applied to Dest
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync followed by the same sequence of uses of the VA_ARG macro as had previously been used to reach
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the present state of Start.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Dest VA_LIST used to traverse the list of arguments.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Start VA_LIST used to traverse the list of arguments.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define VA_COPY(Dest, Start) ((void)((Dest) = (Start)))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Pointer to the start of a variable argument list stored in a memory buffer. Same as UINT8 *.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Returns the size of a data type in sizeof(UINTN) units rounded up to the nearest UINTN boundary.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param TYPE The date type to determine the size of.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The size of TYPE in sizeof (UINTN) units rounded up to the nearest UINTN boundary.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define _BASE_INT_SIZE_OF(TYPE) ((sizeof (TYPE) + sizeof (UINTN) - 1) / sizeof (UINTN))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Returns an argument of a specified type from a variable argument list and updates
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the pointer to the variable argument list to point to the next argument.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function returns an argument of the type specified by TYPE from the beginning
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of the variable argument list specified by Marker. Marker is then updated to point
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to the next argument in the variable argument list. The method for computing the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync pointer to the next argument in the argument list is CPU specific following the EFIAPI ABI.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Marker The pointer to the beginning of a variable argument list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param TYPE The type of argument to retrieve from the beginning
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of the variable argument list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return An argument of the type specified by TYPE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define BASE_ARG(Marker, TYPE) (*(TYPE *) ((Marker += _BASE_INT_SIZE_OF (TYPE)) - _BASE_INT_SIZE_OF (TYPE)))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The macro that returns the byte offset of a field in a data structure.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function returns the offset, in bytes, of field specified by Field from the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync beginning of the data structure specified by TYPE. If TYPE does not contain Field,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the module will not compile.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param TYPE The name of the data structure that contains the field specified by Field.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Field The name of the field in the data structure.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return Offset, in bytes, of field.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define OFFSET_OF(TYPE, Field) ((UINTN) __builtin_offsetof(TYPE, Field))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define OFFSET_OF(TYPE, Field) ((UINTN) &(((TYPE *)0)->Field))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Macro that returns a pointer to the data structure that contains a specified field of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync that data structure. This is a lightweight method to hide information by placing a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync public data structure inside a larger private data structure and using a pointer to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the public data structure to retrieve a pointer to the private data structure.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function computes the offset, in bytes, of field specified by Field from the beginning
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of the data structure specified by TYPE. This offset is subtracted from Record, and is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync used to return a pointer to a data structure of the type specified by TYPE. If the data type
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync specified by TYPE does not contain the field specified by Field, then the module will not compile.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Record Pointer to the field specified by Field within a data structure of type TYPE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param TYPE The name of the data structure type to return. This data structure must
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync contain the field specified by Field.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Field The name of the field in the data structure specified by TYPE to which Record points.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return A pointer to the structure from one of it's elements.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define BASE_CR(Record, TYPE, Field) ((TYPE *) ((CHAR8 *) (Record) - (CHAR8 *) &(((TYPE *) 0)->Field)))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Rounds a value up to the next boundary using a specified alignment.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function rounds Value up to the next boundary using the specified Alignment.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This aligned value is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Value The value to round up.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Alignment The alignment boundary used to return the aligned value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return A value up to the next boundary.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define ALIGN_VALUE(Value, Alignment) ((Value) + (((Alignment) - (Value)) & ((Alignment) - 1)))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Adjust a pointer by adding the minimum offset required for it to be aligned on
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync a specified alignment boundary.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function rounds the pointer specified by Pointer to the next alignment boundary
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync specified by Alignment. The pointer to the aligned address is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Pointer The pointer to round up.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Alignment The alignment boundary to use to return an aligned pointer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return Pointer to the aligned address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define ALIGN_POINTER(Pointer, Alignment) ((VOID *) (ALIGN_VALUE ((UINTN)(Pointer), (Alignment))))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Rounds a value up to the next natural boundary for the current CPU.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This is 4-bytes for 32-bit CPUs and 8-bytes for 64-bit CPUs.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function rounds the value specified by Value up to the next natural boundary for the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync current CPU. This rounded value is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Value The value to round up.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return Rounded value specified by Value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define ALIGN_VARIABLE(Value) ALIGN_VALUE ((Value), sizeof (UINTN))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Return the maximum of two operands.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This macro returns the maximum of two operand specified by a and b.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Both a and b must be the same numerical types, signed or unsigned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param a The first operand with any numerical type.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param b The second operand. Can be any numerical type as long as is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the same type as a.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return Maximum of two operands.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (((a) > (b)) ? (a) : (b))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Return the minimum of two operands.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This macro returns the minimal of two operand specified by a and b.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Both a and b must be the same numerical types, signed or unsigned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param a The first operand with any numerical type.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param b The second operand. It should be the same any numerical type with a.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return Minimum of two operands.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (((a) < (b)) ? (a) : (b))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Return the absolute value of a signed operand.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This macro returns the absolute value of the signed operand specified by a.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param a The signed operand.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The absolute value of the signed operand.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (((a) < 0) ? (-(a)) : (a))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Status codes common to all execution phases
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Produces a RETURN_STATUS code with the highest bit set.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param StatusCode The status code value to convert into a warning code.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync StatusCode must be in the range 0x00000000..0x7FFFFFFF.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The value specified by StatusCode with the highest bit set.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define ENCODE_ERROR(StatusCode) ((RETURN_STATUS)(MAX_BIT | (StatusCode)))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Produces a RETURN_STATUS code with the highest bit clear.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param StatusCode The status code value to convert into a warning code.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync StatusCode must be in the range 0x00000000..0x7FFFFFFF.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The value specified by StatusCode with the highest bit clear.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define ENCODE_WARNING(StatusCode) ((RETURN_STATUS)(StatusCode))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Returns TRUE if a specified RETURN_STATUS code is an error code.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function returns TRUE if StatusCode has the high bit set. Otherwise, FALSE is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param StatusCode The status code value to evaluate.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval TRUE The high bit of StatusCode is set.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval FALSE The high bit of StatusCode is clear.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define RETURN_ERROR(StatusCode) (((INTN)(RETURN_STATUS)(StatusCode)) < 0)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The operation completed successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The image failed to load.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The parameter was incorrect.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The operation is not supported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The buffer was not the proper size for the request.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The buffer was not large enough to hold the requested data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The required buffer size is returned in the appropriate
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// parameter when this error occurs.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// There is no data pending upon return.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The physical device reported an error while attempting the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The device can not be written to.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The resource has run out.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// An inconsistency was detected on the file system causing the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// operation to fail.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// There is no more space on the file system.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The device does not contain any medium to perform the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The medium in the device has changed since the last
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The item was not found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Access was denied.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The server was not found or did not respond to the request.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// A mapping to the device does not exist.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// A timeout time expired.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The protocol has not been started.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The protocol has already been started.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The operation was aborted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// An ICMP error occurred during the network operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// A TFTP error occurred during the network operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// A protocol error occurred during the network operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// A function encountered an internal version that was
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// incompatible with a version requested by the caller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define RETURN_INCOMPATIBLE_VERSION ENCODE_ERROR (25)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The function was not performed due to a security violation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// A CRC error was detected.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The beginning or end of media was reached.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The end of the file was reached.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The language specified was invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The security status of the data is unknown or compromised
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// and the data must be updated or replaced to restore a valid
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// security status.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The string contained one or more characters that
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// the device could not render and were skipped.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define RETURN_WARN_UNKNOWN_GLYPH ENCODE_WARNING (1)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The handle was closed, but the file was not deleted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define RETURN_WARN_DELETE_FAILURE ENCODE_WARNING (2)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The handle was closed, but the data to the file was not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// flushed properly.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define RETURN_WARN_WRITE_FAILURE ENCODE_WARNING (3)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The resulting buffer was too small, and the data was
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// truncated to the buffer size.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define RETURN_WARN_BUFFER_TOO_SMALL ENCODE_WARNING (4)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The data has not been updated within the timeframe set by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// local policy for this type of data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Returns a 16-bit signature built from 2 ASCII characters.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This macro returns a 16-bit value built from the two ASCII characters specified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync by A and B.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param A The first ASCII character.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param B The second ASCII character.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return A 16-bit value built from the two ASCII characters specified by A and B.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Returns a 32-bit signature built from 4 ASCII characters.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This macro returns a 32-bit value built from the four ASCII characters specified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync by A, B, C, and D.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param A The first ASCII character.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param B The second ASCII character.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param C The third ASCII character.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param D The fourth ASCII character.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return A 32-bit value built from the two ASCII characters specified by A, B,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define SIGNATURE_32(A, B, C, D) (SIGNATURE_16 (A, B) | (SIGNATURE_16 (C, D) << 16))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Returns a 64-bit signature built from 8 ASCII characters.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This macro returns a 64-bit value built from the eight ASCII characters specified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync by A, B, C, D, E, F, G,and H.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param A The first ASCII character.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param B The second ASCII character.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param C The third ASCII character.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param D The fourth ASCII character.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param E The fifth ASCII character.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param F The sixth ASCII character.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param G The seventh ASCII character.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param H The eighth ASCII character.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return A 64-bit value built from the two ASCII characters specified by A, B,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync C, D, E, F, G and H.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (SIGNATURE_32 (A, B, C, D) | ((UINT64) (SIGNATURE_32 (E, F, G, H)) << 32))