Attachment #255535 for bug #283037

View | Details | Raw Unified | Return to bug 283037
Collapse All | Expand All




this when performing an upgrade, execute the following:

# Generate list of the headers needed to build
cp -r ..../MdePkg/Include sys/contrib/edk2
cp ..../MdePkg/MdePkg.dec sys/contrib/edk2/MdePkg.dec
cd lib/libefivar
make
pushd `make -V .OBJDIR`


# Merge the needed files
cd ../../sys/contrib/edk2
svn revert -R .
for i in `cat /tmp/xxx`; do
    git add $i
done
git clean -df
    svn+ssh://repo.freebsd.org/base/vendor/edk2/dist/MdePkg/MdePkg.dec MdePkg.dec




  environment. There are a set of base libraries in the Mde Package that can
  be used to implement base modules.

Copyright (c) 2006 - 2021, Intel Corporation. All rights reserved.<BR>
Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent

**/


#ifndef __BASE_H__
#define __BASE_H__


//
#include <ProcessorBind.h>

#if defined (_MSC_EXTENSIONS)
//
// Disable warning when last field of data structure is a zero sized array.
//
  #pragma warning ( disable : 4200 )
#endif

//

//  if the /OPT:REF linker option is used. We defined a macro as this is a
//  a non standard extension
//
#if defined (_MSC_VER) && _MSC_VER < 1800 && !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

//

//
#ifndef UNREACHABLE
  #ifdef __GNUC__
///
/// 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 ()
  #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


//
#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


#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


#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


///
#ifndef RETURNS_TWICE
  #if defined (__GNUC__) || defined (__clang__)
///
/// Tell the code optimizer that the function will return twice.
/// This prevents wrong optimizations which can cause bugs.
///
#define RETURNS_TWICE  __attribute__((returns_twice))
  #else
///
/// Tell the code optimizer that the function will return twice.
/// This prevents wrong optimizations which can cause bugs.
///
#define RETURNS_TWICE
  #endif
#endif


///
/// 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)

#ifdef __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

#define PACKED
  //
  // 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;

//

/// _LIST_ENTRY structure definition.
///
struct _LIST_ENTRY {
  LIST_ENTRY    *ForwardLink;
  LIST_ENTRY    *BackLink;
};

//

///
/// 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.

/// 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 *)
///
#if defined (__cplusplus)
  #if defined (_MSC_EXTENSIONS)
#define NULL  nullptr
  #else
#define NULL  __null
  #endif
#else
#define NULL  ((VOID *) 0)
#endif

//
// Null character
//
#define CHAR_NULL  0x0000

///
/// Maximum values for common UEFI Data Types

#define MIN_INT32  (((INT32) -2147483647) - 1)
#define MIN_INT64  (((INT64) -9223372036854775807LL) - 1)

#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


  @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

#if defined (_M_ARM) || defined (_M_ARM64)

#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(_M_ARM) || defined(_M_ARM64)
//
// MSFT ARM variable argument list support.
//

typedef char *VA_LIST;

#define VA_START(Marker, Parameter)  __va_start (&Marker, &Parameter, _INT_SIZE_OF (Parameter), __alignof(Parameter), &Parameter)
#define VA_ARG(Marker, TYPE)         (*(TYPE *) ((Marker += _INT_SIZE_OF (TYPE) + ((-(INTN)Marker) & (sizeof(TYPE) - 1))) - _INT_SIZE_OF (TYPE)))
#define VA_END(Marker)               (Marker = (VA_LIST) 0)
#define VA_COPY(Dest, Start)         ((void)((Dest) = (Start)))

#elif defined (__GNUC__) || defined (__clang__)

  #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.
//


#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.
//


#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
///

  @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

  @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.

  @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.

///
/// 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.


  @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

  @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.

  @return  Offset, in bytes, of field.

**/
#if (defined (__GNUC__) && __GNUC__ >= 4) || defined (__clang__)
#define OFFSET_OF(TYPE, Field)  ((UINTN) __builtin_offsetof(TYPE, Field))
#endif

#ifndef OFFSET_OF
#define OFFSET_OF(TYPE, Field)  ((UINTN) &(((TYPE *)0)->Field))
#endif

/**
  Returns the alignment requirement of a type.

  @param   TYPE  The name of the type to retrieve the alignment requirement of.

  @return  Alignment requirement, in Bytes, of TYPE.
**/
#if defined (__cplusplus)
//
// Standard C++ operator.
//
#define ALIGNOF(TYPE)  alignof (TYPE)
#elif defined (__GNUC__) || defined (__clang__) || (defined (_MSC_VER) && _MSC_VER >= 1900)
//
// All supported versions of GCC and Clang, as well as MSVC 2015 and later,
// support the standard operator _Alignof.
//
#define ALIGNOF(TYPE)  _Alignof (TYPE)
#elif defined (_MSC_EXTENSIONS)
//
// Earlier versions of MSVC, at least MSVC 2008 and later, support the vendor
// extension __alignof.
//
#define ALIGNOF(TYPE)  __alignof (TYPE)
#else
//
// For compilers that do not support inbuilt alignof operators, use OFFSET_OF.
// CHAR8 is known to have both a size and an alignment requirement of 1 Byte.
// As such, A must be located exactly at the offset equal to its alignment
// requirement.
//
#define ALIGNOF(TYPE)  OFFSET_OF (struct { CHAR8 C; TYPE A; }, A)
#endif

/**


**/
#ifdef MDE_CPU_EBC
#define STATIC_ASSERT(Expression, Message)
#elif defined (_MSC_EXTENSIONS) || defined (__cplusplus)
#define STATIC_ASSERT  static_assert
#else
#define STATIC_ASSERT  _Static_assert
#endif

//

STATIC_ASSERT (sizeof (CHAR8)   == 1, "sizeof (CHAR8) does not meet UEFI Specification Data Type requirements");
STATIC_ASSERT (sizeof (CHAR16)  == 2, "sizeof (CHAR16) does not meet UEFI Specification Data Type requirements");

STATIC_ASSERT (ALIGNOF (BOOLEAN) == sizeof (BOOLEAN), "Alignment of BOOLEAN does not meet UEFI Specification Data Type requirements");
STATIC_ASSERT (ALIGNOF (INT8)    == sizeof (INT8), "Alignment of INT8 does not meet UEFI Specification Data Type requirements");
STATIC_ASSERT (ALIGNOF (UINT8)   == sizeof (UINT8), "Alignment of INT16 does not meet UEFI Specification Data Type requirements");
STATIC_ASSERT (ALIGNOF (INT16)   == sizeof (INT16), "Alignment of INT16 does not meet UEFI Specification Data Type requirements");
STATIC_ASSERT (ALIGNOF (UINT16)  == sizeof (UINT16), "Alignment of UINT16 does not meet UEFI Specification Data Type requirements");
STATIC_ASSERT (ALIGNOF (INT32)   == sizeof (INT32), "Alignment of INT32 does not meet UEFI Specification Data Type requirements");
STATIC_ASSERT (ALIGNOF (UINT32)  == sizeof (UINT32), "Alignment of UINT32 does not meet UEFI Specification Data Type requirements");
STATIC_ASSERT (ALIGNOF (INT64)   == sizeof (INT64), "Alignment of INT64 does not meet UEFI Specification Data Type requirements");
STATIC_ASSERT (ALIGNOF (UINT64)  == sizeof (UINT64), "Alignment of UINT64 does not meet UEFI Specification Data Type requirements");
STATIC_ASSERT (ALIGNOF (CHAR8)   == sizeof (CHAR8), "Alignment of CHAR8 does not meet UEFI Specification Data Type requirements");
STATIC_ASSERT (ALIGNOF (CHAR16)  == sizeof (CHAR16), "Alignment of CHAR16 does not meet UEFI Specification Data Type requirements");
STATIC_ASSERT (ALIGNOF (INTN)    == sizeof (INTN), "Alignment of INTN does not meet UEFI Specification Data Type requirements");
STATIC_ASSERT (ALIGNOF (UINTN)   == sizeof (UINTN), "Alignment of UINTN does not meet UEFI Specification Data Type requirements");
STATIC_ASSERT (ALIGNOF (VOID *)  == sizeof (VOID *), "Alignment of VOID * does not meet UEFI Specification Data Type requirements");

//
// 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.1 Errata C 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_UINT16_ENUM_SIZE;

typedef enum {
  __VerifyInt32EnumValue = 0x7fffffff
} __VERIFY_INT32_ENUM_SIZE;

STATIC_ASSERT (sizeof (__VERIFY_UINT8_ENUM_SIZE) == 4, "Size of enum does not meet UEFI Specification Data Type requirements");
STATIC_ASSERT (sizeof (__VERIFY_UINT16_ENUM_SIZE) == 4, "Size of enum does not meet UEFI Specification Data Type requirements");
STATIC_ASSERT (sizeof (__VERIFY_INT32_ENUM_SIZE) == 4, "Size of enum does not meet UEFI Specification Data Type requirements");

STATIC_ASSERT (ALIGNOF (__VERIFY_UINT8_ENUM_SIZE)  == sizeof (__VERIFY_UINT8_ENUM_SIZE), "Alignment of enum does not meet UEFI Specification Data Type requirements");
STATIC_ASSERT (ALIGNOF (__VERIFY_UINT16_ENUM_SIZE) == sizeof (__VERIFY_UINT16_ENUM_SIZE), "Alignment of enum does not meet UEFI Specification Data Type requirements");
STATIC_ASSERT (ALIGNOF (__VERIFY_INT32_ENUM_SIZE) == sizeof (__VERIFY_INT32_ENUM_SIZE), "Alignment of enum does not meet UEFI Specification Data Type requirements");

/**
  Macro that returns a pointer to the data structure that contains a specified field of

**/
#define BASE_CR(Record, TYPE, Field)  ((TYPE *) ((CHAR8 *) (Record) - OFFSET_OF (TYPE, Field)))

/**
  Checks whether a value is a power of two.

  @param   Value  The value to check.

  @retval TRUE   Value is a power of two.
  @retval FALSE  Value is not a power of two.
**/
#define IS_POW2(Value)  ((Value) != 0U && ((Value) & ((Value) - 1U)) == 0U)

/**
  Checks whether a value is aligned by a specified alignment.

  @param   Value      The value to check.
  @param   Alignment  The alignment boundary used to check against.

  @retval TRUE   Value is aligned by Alignment.
  @retval FALSE  Value is not aligned by Alignment.
**/
#define IS_ALIGNED(Value, Alignment)  (((Value) & ((Alignment) - 1U)) == 0U)

/**
  Checks whether a pointer or address is aligned by a specified alignment.

  @param   Address    The pointer or address to check.
  @param   Alignment  The alignment boundary used to check against.

  @retval TRUE   Address is aligned by Alignment.
  @retval FALSE  Address is not aligned by Alignment.
**/
#define ADDRESS_IS_ALIGNED(Address, Alignment)  IS_ALIGNED ((UINTN) (Address), Alignment)

/**
  Determines the addend to add to a value to round it up to the next boundary of
  a specified alignment.

  @param   Value      The value to round up.
  @param   Alignment  The alignment boundary used to return the addend.

  @return  Addend to round Value up to alignment boundary Alignment.
**/
#define ALIGN_VALUE_ADDEND(Value, Alignment)  (((Alignment) - (Value)) & ((Alignment) - 1U))

/**
  Rounds a value up to the next boundary using a specified alignment.


  @return  A value up to the next boundary.

**/
#define ALIGN_VALUE(Value, Alignment)  ((Value) + ALIGN_VALUE_ADDEND (Value, Alignment))

/**
  Adjust a pointer by adding the minimum offset required for it to be aligned on

  @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.

**/
#define ALIGN_VARIABLE(Value)  ALIGN_VALUE ((Value), sizeof (UINTN))


/**
  Return the maximum of two operands.


  @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.

  @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.

  @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  (RETURN_STATUS)(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

///
/// 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)

///
/// There is an address conflict address allocation.
///
#define RETURN_IP_ADDRESS_CONFLICT  ENCODE_ERROR (34)

///
/// 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)

///
/// The operation will be processed across a system reset.
///
#define RETURN_WARN_RESET_REQUIRED  ENCODE_WARNING (7)

/**
  Returns a 16-bit signature built from 2 ASCII characters.

  @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.

#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)
void *
_ReturnAddress (
  void
  );

  #pragma intrinsic(_ReturnAddress)
  /**
    Get the return address of the calling function.

/**
  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__) || defined (__clang__)
  void * __builtin_return_address (unsigned int level);
  /**
    Get the return address of the calling function.

/**
  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.

/**
  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 Array. The result has type UINTN.

**/
#define ARRAY_SIZE(Array)  (sizeof (Array) / sizeof ((Array)[0]))

#endif


Lines 14-19 Link Here

(-)b/sys/contrib/edk2/Include/Guid/HiiFormMapMethodGuid.h (-1 / +1 lines)
14	#define EFI_HII_STANDARD_FORM_GUID \	14	#define EFI_HII_STANDARD_FORM_GUID \
15	{ 0x3bd2f4ec, 0xe524, 0x46e4, { 0xa9, 0xd8, 0x51, 0x1, 0x17, 0x42, 0x55, 0x62 } }	15	{ 0x3bd2f4ec, 0xe524, 0x46e4, { 0xa9, 0xd8, 0x51, 0x1, 0x17, 0x42, 0x55, 0x62 } }
16		16
17	extern EFI_GUID gEfiHiiStandardFormGuid;	17	extern EFI_GUID gEfiHiiStandardFormGuid;
18		18
19	#endif	19	#endif

Lines 42-52 Link Here

(-)b/sys/contrib/edk2/Include/Guid/PcAnsi.h (-6 / +6 lines)
42	0xd487ddb4, 0x008b, 0x11d9, {0xaf, 0xdc, 0x00, 0x10, 0x83, 0xff, 0xca, 0x4d } \	42	0xd487ddb4, 0x008b, 0x11d9, {0xaf, 0xdc, 0x00, 0x10, 0x83, 0xff, 0xca, 0x4d } \
43	}	43	}
44		44
45	extern EFI_GUID gEfiPcAnsiGuid;	45	extern EFI_GUID gEfiPcAnsiGuid;
46	extern EFI_GUID gEfiVT100Guid;	46	extern EFI_GUID gEfiVT100Guid;
47	extern EFI_GUID gEfiVT100PlusGuid;	47	extern EFI_GUID gEfiVT100PlusGuid;
48	extern EFI_GUID gEfiVTUTF8Guid;	48	extern EFI_GUID gEfiVTUTF8Guid;
49	extern EFI_GUID gEfiUartDevicePathGuid;	49	extern EFI_GUID gEfiUartDevicePathGuid;
50	extern EFI_GUID gEfiSasDevicePathGuid;	50	extern EFI_GUID gEfiSasDevicePathGuid;
51		51
52	#endif	52	#endif




//
// _WIN_CERTIFICATE.wCertificateType
//
#define WIN_CERT_TYPE_PKCS_SIGNED_DATA  0x0002
#define WIN_CERT_TYPE_EFI_PKCS115       0x0EF0
#define WIN_CERT_TYPE_EFI_GUID          0x0EF1

///
/// The WIN_CERTIFICATE structure is part of the PE/COFF specification.

  /// The length of the entire certificate,
  /// including the length of the header, in bytes.
  ///
  UINT32    dwLength;
  ///
  /// The revision level of the WIN_CERTIFICATE
  /// structure. The current revision level is 0x0200.
  ///
  UINT16    wRevision;
  ///
  /// The certificate type. See WIN_CERT_TYPE_xxx for the UEFI
  /// certificate types. The UEFI specification reserves the range of
  /// certificate type values from 0x0EF0 to 0x0EFF.
  ///
  UINT16    wCertificateType;
  ///
  /// The following is the actual certificate. The format of
  /// the certificate depends on wCertificateType.

/// WIN_CERTIFICATE_UEFI_GUID.CertData
///
typedef struct {
  EFI_GUID    HashType;
  UINT8       PublicKey[256];
  UINT8       Signature[256];
} EFI_CERT_BLOCK_RSA_2048_SHA256;


///
/// Certificate which encapsulates a GUID-specific digital signature
///

  /// This is the standard WIN_CERTIFICATE header, where
  /// wCertificateType is set to WIN_CERT_TYPE_EFI_GUID.
  ///
  WIN_CERTIFICATE    Hdr;
  ///
  /// This is the unique id which determines the
  /// format of the CertData. .
  ///
  EFI_GUID           CertType;
  ///
  /// The following is the certificate data. The format of
  /// the data is determined by the CertType.
  /// If CertType is EFI_CERT_TYPE_RSA2048_SHA256_GUID,
  /// the CertData will be EFI_CERT_BLOCK_RSA_2048_SHA256 structure.
  ///
  UINT8              CertData[1];
} WIN_CERTIFICATE_UEFI_GUID;


///
/// Certificate which encapsulates the RSASSA_PKCS1-v1_5 digital signature.
///

  /// This is the standard WIN_CERTIFICATE header, where
  /// wCertificateType is set to WIN_CERT_TYPE_UEFI_PKCS1_15.
  ///
  WIN_CERTIFICATE    Hdr;
  ///
  /// This is the hashing algorithm which was performed on the
  /// UEFI executable when creating the digital signature.
  ///
  EFI_GUID           HashAlgorithm;
  ///
  /// The following is the actual digital signature. The
  /// size of the signature is the same size as the key

  ///
} WIN_CERTIFICATE_EFI_PKCS1_15;

extern EFI_GUID  gEfiCertTypeRsa2048Sha256Guid;

#endif




  ACPI 1.0b definitions from the ACPI Specification, revision 1.0b

Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
Copyright (c) 2020, Arm Limited. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
**/


/// excluding the RSD PTR structure.
///
typedef struct {
  UINT32    Signature;
  UINT32    Length;
} EFI_ACPI_COMMON_HEADER;

#pragma pack(1)

/// The common ACPI description table header.  This structure prefaces most ACPI tables.
///
typedef struct {
  UINT32    Signature;
  UINT32    Length;
  UINT8     Revision;
  UINT8     Checksum;
  UINT8     OemId[6];
  UINT64    OemTableId;
  UINT32    OemRevision;
  UINT32    CreatorId;
  UINT32    CreatorRevision;
} EFI_ACPI_DESCRIPTION_HEADER;
#pragma pack()

//
// Define for Descriptor
//
#define ACPI_SMALL_ITEM_FLAG  0x00
#define ACPI_LARGE_ITEM_FLAG  0x01

//
// Small Item Descriptor Name
//
#define ACPI_SMALL_IRQ_DESCRIPTOR_NAME              0x04
#define ACPI_SMALL_DMA_DESCRIPTOR_NAME              0x05
#define ACPI_SMALL_START_DEPENDENT_DESCRIPTOR_NAME  0x06
#define ACPI_SMALL_END_DEPENDENT_DESCRIPTOR_NAME    0x07
#define ACPI_SMALL_IO_PORT_DESCRIPTOR_NAME          0x08
#define ACPI_SMALL_FIXED_IO_PORT_DESCRIPTOR_NAME    0x09
#define ACPI_SMALL_VENDOR_DEFINED_DESCRIPTOR_NAME   0x0E
#define ACPI_SMALL_END_TAG_DESCRIPTOR_NAME          0x0F

//
// Large Item Descriptor Name
//
#define ACPI_LARGE_24_BIT_MEMORY_RANGE_DESCRIPTOR_NAME        0x01
#define ACPI_LARGE_VENDOR_DEFINED_DESCRIPTOR_NAME             0x04
#define ACPI_LARGE_32_BIT_MEMORY_RANGE_DESCRIPTOR_NAME        0x05
#define ACPI_LARGE_32_BIT_FIXED_MEMORY_RANGE_DESCRIPTOR_NAME  0x06
#define ACPI_LARGE_DWORD_ADDRESS_SPACE_DESCRIPTOR_NAME        0x07
#define ACPI_LARGE_WORD_ADDRESS_SPACE_DESCRIPTOR_NAME         0x08
#define ACPI_LARGE_EXTENDED_IRQ_DESCRIPTOR_NAME               0x09
#define ACPI_LARGE_QWORD_ADDRESS_SPACE_DESCRIPTOR_NAME        0x0A

//
// Small Item Descriptor Value
//
#define ACPI_IRQ_NOFLAG_DESCRIPTOR              0x22
#define ACPI_IRQ_DESCRIPTOR                     0x23
#define ACPI_DMA_DESCRIPTOR                     0x2A
#define ACPI_START_DEPENDENT_DESCRIPTOR         0x30
#define ACPI_START_DEPENDENT_EX_DESCRIPTOR      0x31
#define ACPI_END_DEPENDENT_DESCRIPTOR           0x38
#define ACPI_IO_PORT_DESCRIPTOR                 0x47
#define ACPI_FIXED_LOCATION_IO_PORT_DESCRIPTOR  0x4B
#define ACPI_END_TAG_DESCRIPTOR                 0x79

//
// Large Item Descriptor Value
//
#define ACPI_24_BIT_MEMORY_RANGE_DESCRIPTOR        0x81
#define ACPI_32_BIT_MEMORY_RANGE_DESCRIPTOR        0x85
#define ACPI_32_BIT_FIXED_MEMORY_RANGE_DESCRIPTOR  0x86
#define ACPI_DWORD_ADDRESS_SPACE_DESCRIPTOR        0x87
#define ACPI_WORD_ADDRESS_SPACE_DESCRIPTOR         0x88
#define ACPI_EXTENDED_INTERRUPT_DESCRIPTOR         0x89
#define ACPI_QWORD_ADDRESS_SPACE_DESCRIPTOR        0x8A
#define ACPI_ADDRESS_SPACE_DESCRIPTOR              0x8A

//
// Resource Type
//
#define ACPI_ADDRESS_SPACE_TYPE_MEM  0x00
#define ACPI_ADDRESS_SPACE_TYPE_IO   0x01
#define ACPI_ADDRESS_SPACE_TYPE_BUS  0x02

///
/// Power Management Timer frequency is fixed at 3.579545MHz.
///
#define ACPI_TIMER_FREQUENCY  3579545

//
// Ensure proper structure formats

/// Address Space Descriptors.
///
typedef PACKED struct {
  UINT8     Desc;
  UINT16    Len;
  UINT8     ResType;
  UINT8     GenFlag;
  UINT8     SpecificFlag;
  UINT64    AddrSpaceGranularity;
  UINT64    AddrRangeMin;
  UINT64    AddrRangeMax;
  UINT64    AddrTranslationOffset;
  UINT64    AddrLen;
} EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR;

typedef PACKED union {
  UINT8    Byte;
  PACKED struct {
    UINT8    Length : 3;
    UINT8    Name   : 4;
    UINT8    Type   : 1;
  } Bits;
} ACPI_SMALL_RESOURCE_HEADER;

typedef PACKED struct {
  PACKED union {
    UINT8    Byte;
    PACKED struct {
      UINT8    Name : 7;
      UINT8    Type : 1;
    } Bits;
  } Header;
  UINT16    Length;
} ACPI_LARGE_RESOURCE_HEADER;

///
/// IRQ Descriptor.
///
typedef PACKED struct {
  ACPI_SMALL_RESOURCE_HEADER    Header;
  UINT16                        Mask;
} EFI_ACPI_IRQ_NOFLAG_DESCRIPTOR;

///
/// IRQ Descriptor.
///
typedef PACKED struct {
  ACPI_SMALL_RESOURCE_HEADER    Header;
  UINT16                        Mask;
  UINT8                         Information;
} EFI_ACPI_IRQ_DESCRIPTOR;

///
/// DMA Descriptor.
///
typedef PACKED struct {
  ACPI_SMALL_RESOURCE_HEADER    Header;
  UINT8                         ChannelMask;
  UINT8                         Information;
} EFI_ACPI_DMA_DESCRIPTOR;

///
/// I/O Port Descriptor
///
typedef PACKED struct {
  ACPI_SMALL_RESOURCE_HEADER    Header;
  UINT8                         Information;
  UINT16                        BaseAddressMin;
  UINT16                        BaseAddressMax;
  UINT8                         Alignment;
  UINT8                         Length;
} EFI_ACPI_IO_PORT_DESCRIPTOR;

///
/// Fixed Location I/O Port Descriptor.
///
typedef PACKED struct {
  ACPI_SMALL_RESOURCE_HEADER    Header;
  UINT16                        BaseAddress;
  UINT8                         Length;
} EFI_ACPI_FIXED_LOCATION_IO_PORT_DESCRIPTOR;

///

/// The End tag identifies an end of resource data.
///
typedef struct {
  UINT8    Desc;
  UINT8    Checksum;
} EFI_ACPI_END_TAG_DESCRIPTOR;

//
// General use definitions
//
#define EFI_ACPI_RESERVED_BYTE   0x00
#define EFI_ACPI_RESERVED_WORD   0x0000
#define EFI_ACPI_RESERVED_DWORD  0x00000000
#define EFI_ACPI_RESERVED_QWORD  0x0000000000000000

//
// Resource Type Specific Flags

//
// Bit [0]    : Write Status, _RW
//
#define EFI_ACPI_MEMORY_RESOURCE_SPECIFIC_FLAG_READ_WRITE  (1 << 0)
#define EFI_ACPI_MEMORY_RESOURCE_SPECIFIC_FLAG_READ_ONLY   (0 << 0)
//
// Bit [2:1]  : Memory Attributes, _MEM
//
#define EFI_ACPI_MEMORY_RESOURCE_SPECIFIC_FLAG_NON_CACHEABLE              (0 << 1)
#define EFI_ACPI_MEMORY_RESOURCE_SPECIFIC_FLAG_CACHEABLE                  (1 << 1)
#define EFI_ACPI_MEMORY_RESOURCE_SPECIFIC_FLAG_CACHEABLE_WRITE_COMBINING  (2 << 1)
#define EFI_ACPI_MEMORY_RESOURCE_SPECIFIC_FLAG_CACHEABLE_PREFETCHABLE     (3 << 1)
//
// Bit [4:3]  : Memory Attributes, _MTP
//
#define EFI_ACPI_MEMORY_RESOURCE_SPECIFIC_FLAG_ADDRESS_RANGE_MEMORY    (0 << 3)
#define EFI_ACPI_MEMORY_RESOURCE_SPECIFIC_FLAG_ADDRESS_RANGE_RESERVED  (1 << 3)
#define EFI_ACPI_MEMORY_RESOURCE_SPECIFIC_FLAG_ADDRESS_RANGE_ACPI      (2 << 3)
#define EFI_APCI_MEMORY_RESOURCE_SPECIFIC_FLAG_ADDRESS_RANGE_NVS       (3 << 3)
//
// Bit [5]    : Memory to I/O Translation, _TTP
//
#define EFI_ACPI_MEMORY_RESOURCE_SPECIFIC_FLAG_TYPE_TRANSLATION  (1 << 5)
#define EFI_ACPI_MEMORY_RESOURCE_SPECIFIC_FLAG_TYPE_STATIC       (0 << 5)

//
// IRQ Information
// Ref ACPI specification 6.4.2.1
//
#define EFI_ACPI_IRQ_SHARABLE_MASK  0x10
#define   EFI_ACPI_IRQ_SHARABLE     0x10

#define EFI_ACPI_IRQ_POLARITY_MASK  0x08
#define   EFI_ACPI_IRQ_HIGH_TRUE    0x00
#define   EFI_ACPI_IRQ_LOW_FALSE    0x08

#define EFI_ACPI_IRQ_MODE               0x01
#define   EFI_ACPI_IRQ_LEVEL_TRIGGERED  0x00
#define   EFI_ACPI_IRQ_EDGE_TRIGGERED   0x01

//
// DMA Information
// Ref ACPI specification 6.4.2.2
//
#define EFI_ACPI_DMA_SPEED_TYPE_MASK             0x60
#define   EFI_ACPI_DMA_SPEED_TYPE_COMPATIBILITY  0x00
#define   EFI_ACPI_DMA_SPEED_TYPE_A              0x20
#define   EFI_ACPI_DMA_SPEED_TYPE_B              0x40
#define   EFI_ACPI_DMA_SPEED_TYPE_F              0x60

#define EFI_ACPI_DMA_BUS_MASTER_MASK  0x04
#define   EFI_ACPI_DMA_BUS_MASTER     0x04

#define EFI_ACPI_DMA_TRANSFER_TYPE_MASK                0x03
#define   EFI_ACPI_DMA_TRANSFER_TYPE_8_BIT             0x00
#define   EFI_ACPI_DMA_TRANSFER_TYPE_8_BIT_AND_16_BIT  0x01
#define   EFI_ACPI_DMA_TRANSFER_TYPE_16_BIT            0x02

//
// IO Information
// Ref ACPI specification 6.4.2.5
//
#define EFI_ACPI_IO_DECODE_MASK      0x01
#define   EFI_ACPI_IO_DECODE_16_BIT  0x01
#define   EFI_ACPI_IO_DECODE_10_BIT  0x00

//
// Memory Information
// Ref ACPI specification 6.4.3.4
//
#define EFI_ACPI_MEMORY_WRITE_STATUS_MASK  0x01
#define   EFI_ACPI_MEMORY_WRITABLE         0x01
#define   EFI_ACPI_MEMORY_NON_WRITABLE     0x00

//
// Interrupt Vector Flags definitions for Extended Interrupt Descriptor
// Ref ACPI specification 6.4.3.6
//
#define EFI_ACPI_EXTENDED_INTERRUPT_FLAG_PRODUCER_CONSUMER_MASK  BIT0
#define EFI_ACPI_EXTENDED_INTERRUPT_FLAG_MODE_MASK               BIT1
#define EFI_ACPI_EXTENDED_INTERRUPT_FLAG_POLARITY_MASK           BIT2
#define EFI_ACPI_EXTENDED_INTERRUPT_FLAG_SHARABLE_MASK           BIT3
#define EFI_ACPI_EXTENDED_INTERRUPT_FLAG_WAKE_CAPABLITY_MASK     BIT4

//
// Ensure proper structure formats

/// Root System Description Pointer Structure.
///
typedef struct {
  UINT64    Signature;
  UINT8     Checksum;
  UINT8     OemId[6];
  UINT8     Reserved;
  UINT32    RsdtAddress;
} EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER;

//

///
/// RSDT Revision (as defined in ACPI 1.0b specification).
///
#define EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_TABLE_REVISION  0x01

///
/// Fixed ACPI Description Table Structure (FADT).
///
typedef struct {
  EFI_ACPI_DESCRIPTION_HEADER    Header;
  UINT32                         FirmwareCtrl;
  UINT32                         Dsdt;
  UINT8                          IntModel;
  UINT8                          Reserved1;
  UINT16                         SciInt;
  UINT32                         SmiCmd;
  UINT8                          AcpiEnable;
  UINT8                          AcpiDisable;
  UINT8                          S4BiosReq;
  UINT8                          Reserved2;
  UINT32                         Pm1aEvtBlk;
  UINT32                         Pm1bEvtBlk;
  UINT32                         Pm1aCntBlk;
  UINT32                         Pm1bCntBlk;
  UINT32                         Pm2CntBlk;
  UINT32                         PmTmrBlk;
  UINT32                         Gpe0Blk;
  UINT32                         Gpe1Blk;
  UINT8                          Pm1EvtLen;
  UINT8                          Pm1CntLen;
  UINT8                          Pm2CntLen;
  UINT8                          PmTmLen;
  UINT8                          Gpe0BlkLen;
  UINT8                          Gpe1BlkLen;
  UINT8                          Gpe1Base;
  UINT8                          Reserved3;
  UINT16                         PLvl2Lat;
  UINT16                         PLvl3Lat;
  UINT16                         FlushSize;
  UINT16                         FlushStride;
  UINT8                          DutyOffset;
  UINT8                          DutyWidth;
  UINT8                          DayAlrm;
  UINT8                          MonAlrm;
  UINT8                          Century;
  UINT8                          Reserved4;
  UINT8                          Reserved5;
  UINT8                          Reserved6;
  UINT32                         Flags;
} EFI_ACPI_1_0_FIXED_ACPI_DESCRIPTION_TABLE;

///

///
#define EFI_ACPI_1_0_FIXED_ACPI_DESCRIPTION_TABLE_REVISION  0x01

#define EFI_ACPI_1_0_INT_MODE_DUAL_PIC       0
#define EFI_ACPI_1_0_INT_MODE_MULTIPLE_APIC  1

//
// Fixed ACPI Description Table Fixed Feature Flags
// All other bits are reserved and must be set to 0.
//
#define EFI_ACPI_1_0_WBINVD        BIT0
#define EFI_ACPI_1_0_WBINVD_FLUSH  BIT1
#define EFI_ACPI_1_0_PROC_C1       BIT2
#define EFI_ACPI_1_0_P_LVL2_UP     BIT3
#define EFI_ACPI_1_0_PWR_BUTTON    BIT4
#define EFI_ACPI_1_0_SLP_BUTTON    BIT5
#define EFI_ACPI_1_0_FIX_RTC       BIT6
#define EFI_ACPI_1_0_RTC_S4        BIT7
#define EFI_ACPI_1_0_TMR_VAL_EXT   BIT8
#define EFI_ACPI_1_0_DCK_CAP       BIT9

///
/// Firmware ACPI Control Structure.
///
typedef struct {
  UINT32    Signature;
  UINT32    Length;
  UINT32    HardwareSignature;
  UINT32    FirmwareWakingVector;
  UINT32    GlobalLock;
  UINT32    Flags;
  UINT8     Reserved[40];
} EFI_ACPI_1_0_FIRMWARE_ACPI_CONTROL_STRUCTURE;

///
/// Firmware Control Structure Feature Flags.
/// All other bits are reserved and must be set to 0.
///
#define EFI_ACPI_1_0_S4BIOS_F  BIT0

///
/// Multiple APIC Description Table header definition.  The rest of the table
/// must be defined in a platform-specific manner.
///
typedef struct {
  EFI_ACPI_DESCRIPTION_HEADER    Header;
  UINT32                         LocalApicAddress;
  UINT32                         Flags;
} EFI_ACPI_1_0_MULTIPLE_APIC_DESCRIPTION_TABLE_HEADER;

///
/// MADT Revision (as defined in ACPI 1.0b specification).
///
#define EFI_ACPI_1_0_MULTIPLE_APIC_DESCRIPTION_TABLE_REVISION  0x01

///
/// Multiple APIC Flags
/// All other bits are reserved and must be set to 0.
///
#define EFI_ACPI_1_0_PCAT_COMPAT  BIT0

//
// Multiple APIC Description Table APIC structure types

/// Processor Local APIC Structure Definition.
///
typedef struct {
  UINT8     Type;
  UINT8     Length;
  UINT8     AcpiProcessorId;
  UINT8     ApicId;
  UINT32    Flags;
} EFI_ACPI_1_0_PROCESSOR_LOCAL_APIC_STRUCTURE;

///
/// Local APIC Flags.  All other bits are reserved and must be 0.
///
#define EFI_ACPI_1_0_LOCAL_APIC_ENABLED  BIT0

///
/// IO APIC Structure.
///
typedef struct {
  UINT8     Type;
  UINT8     Length;
  UINT8     IoApicId;
  UINT8     Reserved;
  UINT32    IoApicAddress;
  UINT32    SystemVectorBase;
} EFI_ACPI_1_0_IO_APIC_STRUCTURE;

///
/// Interrupt Source Override Structure.
///
typedef struct {
  UINT8     Type;
  UINT8     Length;
  UINT8     Bus;
  UINT8     Source;
  UINT32    GlobalSystemInterruptVector;
  UINT16    Flags;
} EFI_ACPI_1_0_INTERRUPT_SOURCE_OVERRIDE_STRUCTURE;

///
/// Non-Maskable Interrupt Source Structure.
///
typedef struct {
  UINT8     Type;
  UINT8     Length;
  UINT16    Flags;
  UINT32    GlobalSystemInterruptVector;
} EFI_ACPI_1_0_NON_MASKABLE_INTERRUPT_SOURCE_STRUCTURE;

///
/// Local APIC NMI Structure.
///
typedef struct {
  UINT8     Type;
  UINT8     Length;
  UINT8     AcpiProcessorId;
  UINT16    Flags;
  UINT8     LocalApicInti;
} EFI_ACPI_1_0_LOCAL_APIC_NMI_STRUCTURE;

///
/// Smart Battery Description Table (SBST)
///
typedef struct {
  EFI_ACPI_DESCRIPTION_HEADER    Header;
  UINT32                         WarningEnergyLevel;
  UINT32                         LowEnergyLevel;
  UINT32                         CriticalEnergyLevel;
} EFI_ACPI_1_0_SMART_BATTERY_DESCRIPTION_TABLE;

//




//
// Define for Descriptor
//
#define ACPI_LARGE_GENERIC_REGISTER_DESCRIPTOR_NAME  0x02

#define ACPI_GENERIC_REGISTER_DESCRIPTOR  0x82

//
// Ensure proper structure formats

/// ACPI 2.0 Generic Address Space definition
///
typedef struct {
  UINT8     AddressSpaceId;
  UINT8     RegisterBitWidth;
  UINT8     RegisterBitOffset;
  UINT8     Reserved;
  UINT64    Address;
} EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE;

//

/// Root System Description Pointer Structure
///
typedef struct {
  UINT64    Signature;
  UINT8     Checksum;
  UINT8     OemId[6];
  UINT8     Revision;
  UINT32    RsdtAddress;
  UINT32    Length;
  UINT64    XsdtAddress;
  UINT8     ExtendedChecksum;
  UINT8     Reserved[3];
} EFI_ACPI_2_0_ROOT_SYSTEM_DESCRIPTION_POINTER;

///
/// RSD_PTR Revision (as defined in ACPI 2.0 spec.)
///
#define EFI_ACPI_2_0_ROOT_SYSTEM_DESCRIPTION_POINTER_REVISION  0x02

///
/// Common table header, this prefaces all ACPI tables, including FACS, but
/// excluding the RSD PTR structure
///
typedef struct {
  UINT32    Signature;
  UINT32    Length;
} EFI_ACPI_2_0_COMMON_HEADER;

//

///
/// RSDT Revision (as defined in ACPI 2.0 spec.)
///
#define EFI_ACPI_2_0_ROOT_SYSTEM_DESCRIPTION_TABLE_REVISION  0x01

//
// Extended System Description Table

///
/// XSDT Revision (as defined in ACPI 2.0 spec.)
///
#define EFI_ACPI_2_0_EXTENDED_SYSTEM_DESCRIPTION_TABLE_REVISION  0x01

///
/// Fixed ACPI Description Table Structure (FADT)
///
typedef struct {
  EFI_ACPI_DESCRIPTION_HEADER               Header;
  UINT32                                    FirmwareCtrl;
  UINT32                                    Dsdt;
  UINT8                                     Reserved0;
  UINT8                                     PreferredPmProfile;
  UINT16                                    SciInt;
  UINT32                                    SmiCmd;
  UINT8                                     AcpiEnable;
  UINT8                                     AcpiDisable;
  UINT8                                     S4BiosReq;
  UINT8                                     PstateCnt;
  UINT32                                    Pm1aEvtBlk;
  UINT32                                    Pm1bEvtBlk;
  UINT32                                    Pm1aCntBlk;
  UINT32                                    Pm1bCntBlk;
  UINT32                                    Pm2CntBlk;
  UINT32                                    PmTmrBlk;
  UINT32                                    Gpe0Blk;
  UINT32                                    Gpe1Blk;
  UINT8                                     Pm1EvtLen;
  UINT8                                     Pm1CntLen;
  UINT8                                     Pm2CntLen;
  UINT8                                     PmTmrLen;
  UINT8                                     Gpe0BlkLen;
  UINT8                                     Gpe1BlkLen;
  UINT8                                     Gpe1Base;
  UINT8                                     CstCnt;
  UINT16                                    PLvl2Lat;
  UINT16                                    PLvl3Lat;
  UINT16                                    FlushSize;
  UINT16                                    FlushStride;
  UINT8                                     DutyOffset;
  UINT8                                     DutyWidth;
  UINT8                                     DayAlrm;
  UINT8                                     MonAlrm;
  UINT8                                     Century;
  UINT16                                    IaPcBootArch;
  UINT8                                     Reserved1;
  UINT32                                    Flags;
  EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE    ResetReg;
  UINT8                                     ResetValue;
  UINT8                                     Reserved2[3];
  UINT64                                    XFirmwareCtrl;
  UINT64                                    XDsdt;
  EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE    XPm1aEvtBlk;
  EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE    XPm1bEvtBlk;
  EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE    XPm1aCntBlk;
  EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE    XPm1bCntBlk;
  EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE    XPm2CntBlk;
  EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE    XPmTmrBlk;
  EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE    XGpe0Blk;
  EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE    XGpe1Blk;
} EFI_ACPI_2_0_FIXED_ACPI_DESCRIPTION_TABLE;

///

//
// Fixed ACPI Description Table Preferred Power Management Profile
//
#define EFI_ACPI_2_0_PM_PROFILE_UNSPECIFIED        0
#define EFI_ACPI_2_0_PM_PROFILE_DESKTOP            1
#define EFI_ACPI_2_0_PM_PROFILE_MOBILE             2
#define EFI_ACPI_2_0_PM_PROFILE_WORKSTATION        3
#define EFI_ACPI_2_0_PM_PROFILE_ENTERPRISE_SERVER  4
#define EFI_ACPI_2_0_PM_PROFILE_SOHO_SERVER        5
#define EFI_ACPI_2_0_PM_PROFILE_APPLIANCE_PC       6

//
// Fixed ACPI Description Table Boot Architecture Flags
// All other bits are reserved and must be set to 0.
//
#define EFI_ACPI_2_0_LEGACY_DEVICES  BIT0
#define EFI_ACPI_2_0_8042            BIT1

//
// Fixed ACPI Description Table Fixed Feature Flags
// All other bits are reserved and must be set to 0.
//
#define EFI_ACPI_2_0_WBINVD         BIT0
#define EFI_ACPI_2_0_WBINVD_FLUSH   BIT1
#define EFI_ACPI_2_0_PROC_C1        BIT2
#define EFI_ACPI_2_0_P_LVL2_UP      BIT3
#define EFI_ACPI_2_0_PWR_BUTTON     BIT4
#define EFI_ACPI_2_0_SLP_BUTTON     BIT5
#define EFI_ACPI_2_0_FIX_RTC        BIT6
#define EFI_ACPI_2_0_RTC_S4         BIT7
#define EFI_ACPI_2_0_TMR_VAL_EXT    BIT8
#define EFI_ACPI_2_0_DCK_CAP        BIT9
#define EFI_ACPI_2_0_RESET_REG_SUP  BIT10
#define EFI_ACPI_2_0_SEALED_CASE    BIT11
#define EFI_ACPI_2_0_HEADLESS       BIT12
#define EFI_ACPI_2_0_CPU_SW_SLP     BIT13

///
/// Firmware ACPI Control Structure
///
typedef struct {
  UINT32    Signature;
  UINT32    Length;
  UINT32    HardwareSignature;
  UINT32    FirmwareWakingVector;
  UINT32    GlobalLock;
  UINT32    Flags;
  UINT64    XFirmwareWakingVector;
  UINT8     Version;
  UINT8     Reserved[31];
} EFI_ACPI_2_0_FIRMWARE_ACPI_CONTROL_STRUCTURE;

///

/// Firmware Control Structure Feature Flags
/// All other bits are reserved and must be set to 0.
///
#define EFI_ACPI_2_0_S4BIOS_F  BIT0

///
/// Multiple APIC Description Table header definition.  The rest of the table
/// must be defined in a platform specific manner.
///
typedef struct {
  EFI_ACPI_DESCRIPTION_HEADER    Header;
  UINT32                         LocalApicAddress;
  UINT32                         Flags;
} EFI_ACPI_2_0_MULTIPLE_APIC_DESCRIPTION_TABLE_HEADER;

///
/// MADT Revision (as defined in ACPI 2.0 spec.)
///
#define EFI_ACPI_2_0_MULTIPLE_APIC_DESCRIPTION_TABLE_REVISION  0x01

///
/// Multiple APIC Flags
/// All other bits are reserved and must be set to 0.
///
#define EFI_ACPI_2_0_PCAT_COMPAT  BIT0

//
// Multiple APIC Description Table APIC structure types

/// Processor Local APIC Structure Definition
///
typedef struct {
  UINT8     Type;
  UINT8     Length;
  UINT8     AcpiProcessorId;
  UINT8     ApicId;
  UINT32    Flags;
} EFI_ACPI_2_0_PROCESSOR_LOCAL_APIC_STRUCTURE;

///
/// Local APIC Flags.  All other bits are reserved and must be 0.
///
#define EFI_ACPI_2_0_LOCAL_APIC_ENABLED  BIT0

///
/// IO APIC Structure
///
typedef struct {
  UINT8     Type;
  UINT8     Length;
  UINT8     IoApicId;
  UINT8     Reserved;
  UINT32    IoApicAddress;
  UINT32    GlobalSystemInterruptBase;
} EFI_ACPI_2_0_IO_APIC_STRUCTURE;

///
/// Interrupt Source Override Structure
///
typedef struct {
  UINT8     Type;
  UINT8     Length;
  UINT8     Bus;
  UINT8     Source;
  UINT32    GlobalSystemInterrupt;
  UINT16    Flags;
} EFI_ACPI_2_0_INTERRUPT_SOURCE_OVERRIDE_STRUCTURE;

///
/// Non-Maskable Interrupt Source Structure
///
typedef struct {
  UINT8     Type;
  UINT8     Length;
  UINT16    Flags;
  UINT32    GlobalSystemInterrupt;
} EFI_ACPI_2_0_NON_MASKABLE_INTERRUPT_SOURCE_STRUCTURE;

///
/// Local APIC NMI Structure
///
typedef struct {
  UINT8     Type;
  UINT8     Length;
  UINT8     AcpiProcessorId;
  UINT16    Flags;
  UINT8     LocalApicLint;
} EFI_ACPI_2_0_LOCAL_APIC_NMI_STRUCTURE;

///
/// Local APIC Address Override Structure
///
typedef struct {
  UINT8     Type;
  UINT8     Length;
  UINT16    Reserved;
  UINT64    LocalApicAddress;
} EFI_ACPI_2_0_LOCAL_APIC_ADDRESS_OVERRIDE_STRUCTURE;

///
/// IO SAPIC Structure
///
typedef struct {
  UINT8     Type;
  UINT8     Length;
  UINT8     IoApicId;
  UINT8     Reserved;
  UINT32    GlobalSystemInterruptBase;
  UINT64    IoSapicAddress;
} EFI_ACPI_2_0_IO_SAPIC_STRUCTURE;

///
/// Local SAPIC Structure
///
typedef struct {
  UINT8     Type;
  UINT8     Length;
  UINT8     AcpiProcessorId;
  UINT8     LocalSapicId;
  UINT8     LocalSapicEid;
  UINT8     Reserved[3];
  UINT32    Flags;
} EFI_ACPI_2_0_PROCESSOR_LOCAL_SAPIC_STRUCTURE;

///
/// Platform Interrupt Sources Structure
///
typedef struct {
  UINT8     Type;
  UINT8     Length;
  UINT16    Flags;
  UINT8     InterruptType;
  UINT8     ProcessorId;
  UINT8     ProcessorEid;
  UINT8     IoSapicVector;
  UINT32    GlobalSystemInterrupt;
  UINT32    Reserved;
} EFI_ACPI_2_0_PLATFORM_INTERRUPT_SOURCES_STRUCTURE;

///
/// Smart Battery Description Table (SBST)
///
typedef struct {
  EFI_ACPI_DESCRIPTION_HEADER    Header;
  UINT32                         WarningEnergyLevel;
  UINT32                         LowEnergyLevel;
  UINT32                         CriticalEnergyLevel;
} EFI_ACPI_2_0_SMART_BATTERY_DESCRIPTION_TABLE;

///
/// SBST Version (as defined in ACPI 2.0 spec.)
///
#define EFI_ACPI_2_0_SMART_BATTERY_DESCRIPTION_TABLE_REVISION  0x01

///
/// Embedded Controller Boot Resources Table (ECDT)

/// a fully qualified reference to the name space object.
///
typedef struct {
  EFI_ACPI_DESCRIPTION_HEADER               Header;
  EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE    EcControl;
  EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE    EcData;
  UINT32                                    Uid;
  UINT8                                     GpeBit;
} EFI_ACPI_2_0_EMBEDDED_CONTROLLER_BOOT_RESOURCES_TABLE;

///




//
// Define for Descriptor
//
#define ACPI_LARGE_EXTENDED_ADDRESS_SPACE_DESCRIPTOR_NAME  0x0B

#define ACPI_EXTENDED_ADDRESS_SPACE_DESCRIPTOR  0x8B

///
/// C-state Coordination Types
/// See s8.4.2.2 _CSD (C-State Dependency)
///
#define ACPI_AML_COORD_TYPE_SW_ALL  0xFC
#define ACPI_AML_COORD_TYPE_SW_ANY  0xFD
#define ACPI_AML_COORD_TYPE_HW_ALL  0xFE

///
/// _PSD Revision for ACPI 3.0
// See s8.4.4.5 _PSD (P-State Dependency)
///
#define EFI_ACPI_3_0_AML_PSD_REVISION  0

//
// Ensure proper structure formats

//
// Memory Type Specific Flags
//
#define EFI_ACPI_MEMORY_TYPE_SPECIFIC_ATTRIBUTES_UC   0x0000000000000001
#define EFI_ACPI_MEMORY_TYPE_SPECIFIC_ATTRIBUTES_WC   0x0000000000000002
#define EFI_ACPI_MEMORY_TYPE_SPECIFIC_ATTRIBUTES_WT   0x0000000000000004
#define EFI_ACPI_MEMORY_TYPE_SPECIFIC_ATTRIBUTES_WB   0x0000000000000008
#define EFI_ACPI_MEMORY_TYPE_SPECIFIC_ATTRIBUTES_UCE  0x0000000000000010
#define EFI_ACPI_MEMORY_TYPE_SPECIFIC_ATTRIBUTES_NV   0x0000000000008000

//
// Ensure proper structure formats

/// ACPI 3.0 Generic Address Space definition
///
typedef struct {
  UINT8     AddressSpaceId;
  UINT8     RegisterBitWidth;
  UINT8     RegisterBitOffset;
  UINT8     AccessSize;
  UINT64    Address;
} EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE;

//

/// Root System Description Pointer Structure
///
typedef struct {
  UINT64    Signature;
  UINT8     Checksum;
  UINT8     OemId[6];
  UINT8     Revision;
  UINT32    RsdtAddress;
  UINT32    Length;
  UINT64    XsdtAddress;
  UINT8     ExtendedChecksum;
  UINT8     Reserved[3];
} EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER;

///
/// RSD_PTR Revision (as defined in ACPI 3.0b spec.)
///
#define EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_POINTER_REVISION  0x02 ///< ACPISpec (Revision 3.0b) says current value is 2

///
/// Common table header, this prefaces all ACPI tables, including FACS, but
/// excluding the RSD PTR structure
///
typedef struct {
  UINT32    Signature;
  UINT32    Length;
} EFI_ACPI_3_0_COMMON_HEADER;

//

///
/// RSDT Revision (as defined in ACPI 3.0 spec.)
///
#define EFI_ACPI_3_0_ROOT_SYSTEM_DESCRIPTION_TABLE_REVISION  0x01

//
// Extended System Description Table

///
/// XSDT Revision (as defined in ACPI 3.0 spec.)
///
#define EFI_ACPI_3_0_EXTENDED_SYSTEM_DESCRIPTION_TABLE_REVISION  0x01

///
/// Fixed ACPI Description Table Structure (FADT)
///
typedef struct {
  EFI_ACPI_DESCRIPTION_HEADER               Header;
  UINT32                                    FirmwareCtrl;
  UINT32                                    Dsdt;
  UINT8                                     Reserved0;
  UINT8                                     PreferredPmProfile;
  UINT16                                    SciInt;
  UINT32                                    SmiCmd;
  UINT8                                     AcpiEnable;
  UINT8                                     AcpiDisable;
  UINT8                                     S4BiosReq;
  UINT8                                     PstateCnt;
  UINT32                                    Pm1aEvtBlk;
  UINT32                                    Pm1bEvtBlk;
  UINT32                                    Pm1aCntBlk;
  UINT32                                    Pm1bCntBlk;
  UINT32                                    Pm2CntBlk;
  UINT32                                    PmTmrBlk;
  UINT32                                    Gpe0Blk;
  UINT32                                    Gpe1Blk;
  UINT8                                     Pm1EvtLen;
  UINT8                                     Pm1CntLen;
  UINT8                                     Pm2CntLen;
  UINT8                                     PmTmrLen;
  UINT8                                     Gpe0BlkLen;
  UINT8                                     Gpe1BlkLen;
  UINT8                                     Gpe1Base;
  UINT8                                     CstCnt;
  UINT16                                    PLvl2Lat;
  UINT16                                    PLvl3Lat;
  UINT16                                    FlushSize;
  UINT16                                    FlushStride;
  UINT8                                     DutyOffset;
  UINT8                                     DutyWidth;
  UINT8                                     DayAlrm;
  UINT8                                     MonAlrm;
  UINT8                                     Century;
  UINT16                                    IaPcBootArch;
  UINT8                                     Reserved1;
  UINT32                                    Flags;
  EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE    ResetReg;
  UINT8                                     ResetValue;
  UINT8                                     Reserved2[3];
  UINT64                                    XFirmwareCtrl;
  UINT64                                    XDsdt;
  EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE    XPm1aEvtBlk;
  EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE    XPm1bEvtBlk;
  EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE    XPm1aCntBlk;
  EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE    XPm1bCntBlk;
  EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE    XPm2CntBlk;
  EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE    XPmTmrBlk;
  EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE    XGpe0Blk;
  EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE    XGpe1Blk;
} EFI_ACPI_3_0_FIXED_ACPI_DESCRIPTION_TABLE;

///

// Fixed ACPI Description Table Boot Architecture Flags
// All other bits are reserved and must be set to 0.
//
#define EFI_ACPI_3_0_LEGACY_DEVICES      BIT0
#define EFI_ACPI_3_0_8042                BIT1
#define EFI_ACPI_3_0_VGA_NOT_PRESENT     BIT2
#define EFI_ACPI_3_0_MSI_NOT_SUPPORTED   BIT3
#define EFI_ACPI_3_0_PCIE_ASPM_CONTROLS  BIT4

//
// Fixed ACPI Description Table Fixed Feature Flags
// All other bits are reserved and must be set to 0.
//
#define EFI_ACPI_3_0_WBINVD                                BIT0
#define EFI_ACPI_3_0_WBINVD_FLUSH                          BIT1
#define EFI_ACPI_3_0_PROC_C1                               BIT2
#define EFI_ACPI_3_0_P_LVL2_UP                             BIT3
#define EFI_ACPI_3_0_PWR_BUTTON                            BIT4
#define EFI_ACPI_3_0_SLP_BUTTON                            BIT5
#define EFI_ACPI_3_0_FIX_RTC                               BIT6
#define EFI_ACPI_3_0_RTC_S4                                BIT7
#define EFI_ACPI_3_0_TMR_VAL_EXT                           BIT8
#define EFI_ACPI_3_0_DCK_CAP                               BIT9
#define EFI_ACPI_3_0_RESET_REG_SUP                         BIT10
#define EFI_ACPI_3_0_SEALED_CASE                           BIT11
#define EFI_ACPI_3_0_HEADLESS                              BIT12
#define EFI_ACPI_3_0_CPU_SW_SLP                            BIT13
#define EFI_ACPI_3_0_PCI_EXP_WAK                           BIT14
#define EFI_ACPI_3_0_USE_PLATFORM_CLOCK                    BIT15
#define EFI_ACPI_3_0_S4_RTC_STS_VALID                      BIT16
#define EFI_ACPI_3_0_REMOTE_POWER_ON_CAPABLE               BIT17
#define EFI_ACPI_3_0_FORCE_APIC_CLUSTER_MODEL              BIT18
#define EFI_ACPI_3_0_FORCE_APIC_PHYSICAL_DESTINATION_MODE  BIT19

///
/// Firmware ACPI Control Structure
///
typedef struct {
  UINT32    Signature;
  UINT32    Length;
  UINT32    HardwareSignature;
  UINT32    FirmwareWakingVector;
  UINT32    GlobalLock;
  UINT32    Flags;
  UINT64    XFirmwareWakingVector;
  UINT8     Version;
  UINT8     Reserved[31];
} EFI_ACPI_3_0_FIRMWARE_ACPI_CONTROL_STRUCTURE;

///

/// Firmware Control Structure Feature Flags
/// All other bits are reserved and must be set to 0.
///
#define EFI_ACPI_3_0_S4BIOS_F  BIT0

//
// Differentiated System Description Table,

// no definition needed as they are common description table header, the same with
// EFI_ACPI_DESCRIPTION_HEADER, followed by a definition block.
//
#define EFI_ACPI_3_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_REVISION  0x02
#define EFI_ACPI_3_0_SECONDARY_SYSTEM_DESCRIPTION_TABLE_REVISION       0x02

///
/// Multiple APIC Description Table header definition.  The rest of the table
/// must be defined in a platform specific manner.
///
typedef struct {
  EFI_ACPI_DESCRIPTION_HEADER    Header;
  UINT32                         LocalApicAddress;
  UINT32                         Flags;
} EFI_ACPI_3_0_MULTIPLE_APIC_DESCRIPTION_TABLE_HEADER;

///
/// MADT Revision (as defined in ACPI 3.0 spec.)
///
#define EFI_ACPI_3_0_MULTIPLE_APIC_DESCRIPTION_TABLE_REVISION  0x02

///
/// Multiple APIC Flags
/// All other bits are reserved and must be set to 0.
///
#define EFI_ACPI_3_0_PCAT_COMPAT  BIT0

//
// Multiple APIC Description Table APIC structure types

/// Processor Local APIC Structure Definition
///
typedef struct {
  UINT8     Type;
  UINT8     Length;
  UINT8     AcpiProcessorId;
  UINT8     ApicId;
  UINT32    Flags;
} EFI_ACPI_3_0_PROCESSOR_LOCAL_APIC_STRUCTURE;

///
/// Local APIC Flags.  All other bits are reserved and must be 0.
///
#define EFI_ACPI_3_0_LOCAL_APIC_ENABLED  BIT0

///
/// IO APIC Structure
///
typedef struct {
  UINT8     Type;
  UINT8     Length;
  UINT8     IoApicId;
  UINT8     Reserved;
  UINT32    IoApicAddress;
  UINT32    GlobalSystemInterruptBase;
} EFI_ACPI_3_0_IO_APIC_STRUCTURE;

///
/// Interrupt Source Override Structure
///
typedef struct {
  UINT8     Type;
  UINT8     Length;
  UINT8     Bus;
  UINT8     Source;
  UINT32    GlobalSystemInterrupt;
  UINT16    Flags;
} EFI_ACPI_3_0_INTERRUPT_SOURCE_OVERRIDE_STRUCTURE;

///
/// Platform Interrupt Sources Structure Definition
///
typedef struct {
  UINT8     Type;
  UINT8     Length;
  UINT16    Flags;
  UINT8     InterruptType;
  UINT8     ProcessorId;
  UINT8     ProcessorEid;
  UINT8     IoSapicVector;
  UINT32    GlobalSystemInterrupt;
  UINT32    PlatformInterruptSourceFlags;
  UINT8     CpeiProcessorOverride;
  UINT8     Reserved[31];
} EFI_ACPI_3_0_PLATFORM_INTERRUPT_APIC_STRUCTURE;

//

/// Non-Maskable Interrupt Source Structure
///
typedef struct {
  UINT8     Type;
  UINT8     Length;
  UINT16    Flags;
  UINT32    GlobalSystemInterrupt;
} EFI_ACPI_3_0_NON_MASKABLE_INTERRUPT_SOURCE_STRUCTURE;

///
/// Local APIC NMI Structure
///
typedef struct {
  UINT8     Type;
  UINT8     Length;
  UINT8     AcpiProcessorId;
  UINT16    Flags;
  UINT8     LocalApicLint;
} EFI_ACPI_3_0_LOCAL_APIC_NMI_STRUCTURE;

///
/// Local APIC Address Override Structure
///
typedef struct {
  UINT8     Type;
  UINT8     Length;
  UINT16    Reserved;
  UINT64    LocalApicAddress;
} EFI_ACPI_3_0_LOCAL_APIC_ADDRESS_OVERRIDE_STRUCTURE;

///
/// IO SAPIC Structure
///
typedef struct {
  UINT8     Type;
  UINT8     Length;
  UINT8     IoApicId;
  UINT8     Reserved;
  UINT32    GlobalSystemInterruptBase;
  UINT64    IoSapicAddress;
} EFI_ACPI_3_0_IO_SAPIC_STRUCTURE;

///

/// This struct followed by a null-terminated ASCII string - ACPI Processor UID String
///
typedef struct {
  UINT8     Type;
  UINT8     Length;
  UINT8     AcpiProcessorId;
  UINT8     LocalSapicId;
  UINT8     LocalSapicEid;
  UINT8     Reserved[3];
  UINT32    Flags;
  UINT32    ACPIProcessorUIDValue;
} EFI_ACPI_3_0_PROCESSOR_LOCAL_SAPIC_STRUCTURE;

///
/// Platform Interrupt Sources Structure
///
typedef struct {
  UINT8     Type;
  UINT8     Length;
  UINT16    Flags;
  UINT8     InterruptType;
  UINT8     ProcessorId;
  UINT8     ProcessorEid;
  UINT8     IoSapicVector;
  UINT32    GlobalSystemInterrupt;
  UINT32    PlatformInterruptSourceFlags;
} EFI_ACPI_3_0_PLATFORM_INTERRUPT_SOURCES_STRUCTURE;

///
/// Platform Interrupt Source Flags.
/// All other bits are reserved and must be set to 0.
///
#define EFI_ACPI_3_0_CPEI_PROCESSOR_OVERRIDE  BIT0

///
/// Smart Battery Description Table (SBST)
///
typedef struct {
  EFI_ACPI_DESCRIPTION_HEADER    Header;
  UINT32                         WarningEnergyLevel;
  UINT32                         LowEnergyLevel;
  UINT32                         CriticalEnergyLevel;
} EFI_ACPI_3_0_SMART_BATTERY_DESCRIPTION_TABLE;

///
/// SBST Version (as defined in ACPI 3.0 spec.)
///
#define EFI_ACPI_3_0_SMART_BATTERY_DESCRIPTION_TABLE_REVISION  0x01

///
/// Embedded Controller Boot Resources Table (ECDT)

/// a fully qualified reference to the name space object.
///
typedef struct {
  EFI_ACPI_DESCRIPTION_HEADER               Header;
  EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE    EcControl;
  EFI_ACPI_3_0_GENERIC_ADDRESS_STRUCTURE    EcData;
  UINT32                                    Uid;
  UINT8                                     GpeBit;
} EFI_ACPI_3_0_EMBEDDED_CONTROLLER_BOOT_RESOURCES_TABLE;

///

/// must be defined in a platform specific manner.
///
typedef struct {
  EFI_ACPI_DESCRIPTION_HEADER    Header;
  UINT32                         Reserved1; ///< Must be set to 1
  UINT64                         Reserved2;
} EFI_ACPI_3_0_SYSTEM_RESOURCE_AFFINITY_TABLE_HEADER;

///

/// Processor Local APIC/SAPIC Affinity Structure Definition
///
typedef struct {
  UINT8     Type;
  UINT8     Length;
  UINT8     ProximityDomain7To0;
  UINT8     ApicId;
  UINT32    Flags;
  UINT8     LocalSapicEid;
  UINT8     ProximityDomain31To8[3];
  UINT8     Reserved[4];
} EFI_ACPI_3_0_PROCESSOR_LOCAL_APIC_SAPIC_AFFINITY_STRUCTURE;

///
/// Local APIC/SAPIC Flags.  All other bits are reserved and must be 0.
///
#define EFI_ACPI_3_0_PROCESSOR_LOCAL_APIC_SAPIC_ENABLED  (1 << 0)

///
/// Memory Affinity Structure Definition
///
typedef struct {
  UINT8     Type;
  UINT8     Length;
  UINT32    ProximityDomain;
  UINT16    Reserved1;
  UINT32    AddressBaseLow;
  UINT32    AddressBaseHigh;
  UINT32    LengthLow;
  UINT32    LengthHigh;
  UINT32    Reserved2;
  UINT32    Flags;
  UINT64    Reserved3;
} EFI_ACPI_3_0_MEMORY_AFFINITY_STRUCTURE;

//
// Memory Flags.  All other bits are reserved and must be 0.
//
#define EFI_ACPI_3_0_MEMORY_ENABLED        (1 << 0)
#define EFI_ACPI_3_0_MEMORY_HOT_PLUGGABLE  (1 << 1)
#define EFI_ACPI_3_0_MEMORY_NONVOLATILE    (1 << 2)

///
/// System Locality Distance Information Table (SLIT).
/// The rest of the table is a matrix.
///
typedef struct {
  EFI_ACPI_DESCRIPTION_HEADER    Header;
  UINT64                         NumberOfSystemLocalities;
} EFI_ACPI_3_0_SYSTEM_LOCALITY_DISTANCE_INFORMATION_TABLE_HEADER;

///

Lines 1-7 Link Here

(-)b/sys/contrib/edk2/Include/IndustryStandard/Acpi40.h (-518 / +524 lines)
1	/** @file	1	/** @file
2	ACPI 4.0 definitions from the ACPI Specification Revision 4.0a April 5, 2010	2	ACPI 4.0 definitions from the ACPI Specification Revision 4.0a April 5, 2010
3		3
4	Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.<BR>	4	Copyright (c) 2010 - 2022, Intel Corporation. All rights reserved.<BR>
5	SPDX-License-Identifier: BSD-2-Clause-Patent	5	SPDX-License-Identifier: BSD-2-Clause-Patent
6	**/	6	**/
7		7
Lines 10-15 Link Here
10		10
11	#include <IndustryStandard/Acpi30.h>	11	#include <IndustryStandard/Acpi30.h>
12		12
		13	///
		14	/// _PSD Revision for ACPI 4.0
		15	///
		16	#define EFI_ACPI_4_0_AML_PSD_REVISION 0
		17
13	//	18	//
14	// Ensure proper structure formats	19	// Ensure proper structure formats
15	//	20	//
Lines 19-29 Link Here
19	/// ACPI 4.0 Generic Address Space definition	24	/// ACPI 4.0 Generic Address Space definition
20	///	25	///
21	typedef struct {	26	typedef struct {
22	UINT8 AddressSpaceId;	27	UINT8 AddressSpaceId;
23	UINT8 RegisterBitWidth;	28	UINT8 RegisterBitWidth;
24	UINT8 RegisterBitOffset;	29	UINT8 RegisterBitOffset;
25	UINT8 AccessSize;	30	UINT8 AccessSize;
26	UINT64 Address;	31	UINT64 Address;
27	} EFI_ACPI_4_0_GENERIC_ADDRESS_STRUCTURE;	32	} EFI_ACPI_4_0_GENERIC_ADDRESS_STRUCTURE;
28		33
29	//	34	//
Lines 53-81 typedef struct { Link Here
53	/// Root System Description Pointer Structure	58	/// Root System Description Pointer Structure
54	///	59	///
55	typedef struct {	60	typedef struct {
56	UINT64 Signature;	61	UINT64 Signature;
57	UINT8 Checksum;	62	UINT8 Checksum;
58	UINT8 OemId[6];	63	UINT8 OemId[6];
59	UINT8 Revision;	64	UINT8 Revision;
60	UINT32 RsdtAddress;	65	UINT32 RsdtAddress;
61	UINT32 Length;	66	UINT32 Length;
62	UINT64 XsdtAddress;	67	UINT64 XsdtAddress;
63	UINT8 ExtendedChecksum;	68	UINT8 ExtendedChecksum;
64	UINT8 Reserved[3];	69	UINT8 Reserved[3];
65	} EFI_ACPI_4_0_ROOT_SYSTEM_DESCRIPTION_POINTER;	70	} EFI_ACPI_4_0_ROOT_SYSTEM_DESCRIPTION_POINTER;
66		71
67	///	72	///
68	/// RSD_PTR Revision (as defined in ACPI 4.0b spec.)	73	/// RSD_PTR Revision (as defined in ACPI 4.0b spec.)
69	///	74	///
70	#define EFI_ACPI_4_0_ROOT_SYSTEM_DESCRIPTION_POINTER_REVISION 0x02 ///< ACPISpec (Revision 4.0a) says current value is 2	75	#define EFI_ACPI_4_0_ROOT_SYSTEM_DESCRIPTION_POINTER_REVISION 0x02 ///< ACPISpec (Revision 4.0a) says current value is 2
71		76
72	///	77	///
73	/// Common table header, this prefaces all ACPI tables, including FACS, but	78	/// Common table header, this prefaces all ACPI tables, including FACS, but
74	/// excluding the RSD PTR structure	79	/// excluding the RSD PTR structure
75	///	80	///
76	typedef struct {	81	typedef struct {
77	UINT32 Signature;	82	UINT32 Signature;
78	UINT32 Length;	83	UINT32 Length;
79	} EFI_ACPI_4_0_COMMON_HEADER;	84	} EFI_ACPI_4_0_COMMON_HEADER;
80		85
81	//	86	//
Lines 87-93 typedef struct { Link Here
87	///	92	///
88	/// RSDT Revision (as defined in ACPI 4.0 spec.)	93	/// RSDT Revision (as defined in ACPI 4.0 spec.)
89	///	94	///
90	#define EFI_ACPI_4_0_ROOT_SYSTEM_DESCRIPTION_TABLE_REVISION 0x01	95	#define EFI_ACPI_4_0_ROOT_SYSTEM_DESCRIPTION_TABLE_REVISION 0x01
91		96
92	//	97	//
93	// Extended System Description Table	98	// Extended System Description Table
Lines 98-161 typedef struct { Link Here
98	///	103	///
99	/// XSDT Revision (as defined in ACPI 4.0 spec.)	104	/// XSDT Revision (as defined in ACPI 4.0 spec.)
100	///	105	///
101	#define EFI_ACPI_4_0_EXTENDED_SYSTEM_DESCRIPTION_TABLE_REVISION 0x01	106	#define EFI_ACPI_4_0_EXTENDED_SYSTEM_DESCRIPTION_TABLE_REVISION 0x01
102		107
103	///	108	///
104	/// Fixed ACPI Description Table Structure (FADT)	109	/// Fixed ACPI Description Table Structure (FADT)
105	///	110	///
106	typedef struct {	111	typedef struct {
107	EFI_ACPI_DESCRIPTION_HEADER Header;	112	EFI_ACPI_DESCRIPTION_HEADER Header;
108	UINT32 FirmwareCtrl;	113	UINT32 FirmwareCtrl;
109	UINT32 Dsdt;	114	UINT32 Dsdt;
110	UINT8 Reserved0;	115	UINT8 Reserved0;
111	UINT8 PreferredPmProfile;	116	UINT8 PreferredPmProfile;
112	UINT16 SciInt;	117	UINT16 SciInt;
113	UINT32 SmiCmd;	118	UINT32 SmiCmd;
114	UINT8 AcpiEnable;	119	UINT8 AcpiEnable;
115	UINT8 AcpiDisable;	120	UINT8 AcpiDisable;
116	UINT8 S4BiosReq;	121	UINT8 S4BiosReq;
117	UINT8 PstateCnt;	122	UINT8 PstateCnt;
118	UINT32 Pm1aEvtBlk;	123	UINT32 Pm1aEvtBlk;
119	UINT32 Pm1bEvtBlk;	124	UINT32 Pm1bEvtBlk;
120	UINT32 Pm1aCntBlk;	125	UINT32 Pm1aCntBlk;
121	UINT32 Pm1bCntBlk;	126	UINT32 Pm1bCntBlk;
122	UINT32 Pm2CntBlk;	127	UINT32 Pm2CntBlk;
123	UINT32 PmTmrBlk;	128	UINT32 PmTmrBlk;
124	UINT32 Gpe0Blk;	129	UINT32 Gpe0Blk;
125	UINT32 Gpe1Blk;	130	UINT32 Gpe1Blk;
126	UINT8 Pm1EvtLen;	131	UINT8 Pm1EvtLen;
127	UINT8 Pm1CntLen;	132	UINT8 Pm1CntLen;
128	UINT8 Pm2CntLen;	133	UINT8 Pm2CntLen;
129	UINT8 PmTmrLen;	134	UINT8 PmTmrLen;
130	UINT8 Gpe0BlkLen;	135	UINT8 Gpe0BlkLen;
131	UINT8 Gpe1BlkLen;	136	UINT8 Gpe1BlkLen;
132	UINT8 Gpe1Base;	137	UINT8 Gpe1Base;
133	UINT8 CstCnt;	138	UINT8 CstCnt;
134	UINT16 PLvl2Lat;	139	UINT16 PLvl2Lat;
135	UINT16 PLvl3Lat;	140	UINT16 PLvl3Lat;
136	UINT16 FlushSize;	141	UINT16 FlushSize;
137	UINT16 FlushStride;	142	UINT16 FlushStride;
138	UINT8 DutyOffset;	143	UINT8 DutyOffset;
139	UINT8 DutyWidth;	144	UINT8 DutyWidth;
140	UINT8 DayAlrm;	145	UINT8 DayAlrm;
141	UINT8 MonAlrm;	146	UINT8 MonAlrm;
142	UINT8 Century;	147	UINT8 Century;
143	UINT16 IaPcBootArch;	148	UINT16 IaPcBootArch;
144	UINT8 Reserved1;	149	UINT8 Reserved1;
145	UINT32 Flags;	150	UINT32 Flags;
146	EFI_ACPI_4_0_GENERIC_ADDRESS_STRUCTURE ResetReg;	151	EFI_ACPI_4_0_GENERIC_ADDRESS_STRUCTURE ResetReg;
147	UINT8 ResetValue;	152	UINT8 ResetValue;
148	UINT8 Reserved2[3];	153	UINT8 Reserved2[3];
149	UINT64 XFirmwareCtrl;	154	UINT64 XFirmwareCtrl;
150	UINT64 XDsdt;	155	UINT64 XDsdt;
151	EFI_ACPI_4_0_GENERIC_ADDRESS_STRUCTURE XPm1aEvtBlk;	156	EFI_ACPI_4_0_GENERIC_ADDRESS_STRUCTURE XPm1aEvtBlk;
152	EFI_ACPI_4_0_GENERIC_ADDRESS_STRUCTURE XPm1bEvtBlk;	157	EFI_ACPI_4_0_GENERIC_ADDRESS_STRUCTURE XPm1bEvtBlk;
153	EFI_ACPI_4_0_GENERIC_ADDRESS_STRUCTURE XPm1aCntBlk;	158	EFI_ACPI_4_0_GENERIC_ADDRESS_STRUCTURE XPm1aCntBlk;
154	EFI_ACPI_4_0_GENERIC_ADDRESS_STRUCTURE XPm1bCntBlk;	159	EFI_ACPI_4_0_GENERIC_ADDRESS_STRUCTURE XPm1bCntBlk;
155	EFI_ACPI_4_0_GENERIC_ADDRESS_STRUCTURE XPm2CntBlk;	160	EFI_ACPI_4_0_GENERIC_ADDRESS_STRUCTURE XPm2CntBlk;
156	EFI_ACPI_4_0_GENERIC_ADDRESS_STRUCTURE XPmTmrBlk;	161	EFI_ACPI_4_0_GENERIC_ADDRESS_STRUCTURE XPmTmrBlk;
157	EFI_ACPI_4_0_GENERIC_ADDRESS_STRUCTURE XGpe0Blk;	162	EFI_ACPI_4_0_GENERIC_ADDRESS_STRUCTURE XGpe0Blk;
158	EFI_ACPI_4_0_GENERIC_ADDRESS_STRUCTURE XGpe1Blk;	163	EFI_ACPI_4_0_GENERIC_ADDRESS_STRUCTURE XGpe1Blk;
159	} EFI_ACPI_4_0_FIXED_ACPI_DESCRIPTION_TABLE;	164	} EFI_ACPI_4_0_FIXED_ACPI_DESCRIPTION_TABLE;
160		165
161	///	166	///
Lines 179-230 typedef struct { Link Here
179	// Fixed ACPI Description Table Boot Architecture Flags	184	// Fixed ACPI Description Table Boot Architecture Flags
180	// All other bits are reserved and must be set to 0.	185	// All other bits are reserved and must be set to 0.
181	//	186	//
182	#define EFI_ACPI_4_0_LEGACY_DEVICES BIT0	187	#define EFI_ACPI_4_0_LEGACY_DEVICES BIT0
183	#define EFI_ACPI_4_0_8042 BIT1	188	#define EFI_ACPI_4_0_8042 BIT1
184	#define EFI_ACPI_4_0_VGA_NOT_PRESENT BIT2	189	#define EFI_ACPI_4_0_VGA_NOT_PRESENT BIT2
185	#define EFI_ACPI_4_0_MSI_NOT_SUPPORTED BIT3	190	#define EFI_ACPI_4_0_MSI_NOT_SUPPORTED BIT3
186	#define EFI_ACPI_4_0_PCIE_ASPM_CONTROLS BIT4	191	#define EFI_ACPI_4_0_PCIE_ASPM_CONTROLS BIT4
187		192
188	//	193	//
189	// Fixed ACPI Description Table Fixed Feature Flags	194	// Fixed ACPI Description Table Fixed Feature Flags
190	// All other bits are reserved and must be set to 0.	195	// All other bits are reserved and must be set to 0.
191	//	196	//
192	#define EFI_ACPI_4_0_WBINVD BIT0	197	#define EFI_ACPI_4_0_WBINVD BIT0
193	#define EFI_ACPI_4_0_WBINVD_FLUSH BIT1	198	#define EFI_ACPI_4_0_WBINVD_FLUSH BIT1
194	#define EFI_ACPI_4_0_PROC_C1 BIT2	199	#define EFI_ACPI_4_0_PROC_C1 BIT2
195	#define EFI_ACPI_4_0_P_LVL2_UP BIT3	200	#define EFI_ACPI_4_0_P_LVL2_UP BIT3
196	#define EFI_ACPI_4_0_PWR_BUTTON BIT4	201	#define EFI_ACPI_4_0_PWR_BUTTON BIT4
197	#define EFI_ACPI_4_0_SLP_BUTTON BIT5	202	#define EFI_ACPI_4_0_SLP_BUTTON BIT5
198	#define EFI_ACPI_4_0_FIX_RTC BIT6	203	#define EFI_ACPI_4_0_FIX_RTC BIT6
199	#define EFI_ACPI_4_0_RTC_S4 BIT7	204	#define EFI_ACPI_4_0_RTC_S4 BIT7
200	#define EFI_ACPI_4_0_TMR_VAL_EXT BIT8	205	#define EFI_ACPI_4_0_TMR_VAL_EXT BIT8
201	#define EFI_ACPI_4_0_DCK_CAP BIT9	206	#define EFI_ACPI_4_0_DCK_CAP BIT9
202	#define EFI_ACPI_4_0_RESET_REG_SUP BIT10	207	#define EFI_ACPI_4_0_RESET_REG_SUP BIT10
203	#define EFI_ACPI_4_0_SEALED_CASE BIT11	208	#define EFI_ACPI_4_0_SEALED_CASE BIT11
204	#define EFI_ACPI_4_0_HEADLESS BIT12	209	#define EFI_ACPI_4_0_HEADLESS BIT12
205	#define EFI_ACPI_4_0_CPU_SW_SLP BIT13	210	#define EFI_ACPI_4_0_CPU_SW_SLP BIT13
206	#define EFI_ACPI_4_0_PCI_EXP_WAK BIT14	211	#define EFI_ACPI_4_0_PCI_EXP_WAK BIT14
207	#define EFI_ACPI_4_0_USE_PLATFORM_CLOCK BIT15	212	#define EFI_ACPI_4_0_USE_PLATFORM_CLOCK BIT15
208	#define EFI_ACPI_4_0_S4_RTC_STS_VALID BIT16	213	#define EFI_ACPI_4_0_S4_RTC_STS_VALID BIT16
209	#define EFI_ACPI_4_0_REMOTE_POWER_ON_CAPABLE BIT17	214	#define EFI_ACPI_4_0_REMOTE_POWER_ON_CAPABLE BIT17
210	#define EFI_ACPI_4_0_FORCE_APIC_CLUSTER_MODEL BIT18	215	#define EFI_ACPI_4_0_FORCE_APIC_CLUSTER_MODEL BIT18
211	#define EFI_ACPI_4_0_FORCE_APIC_PHYSICAL_DESTINATION_MODE BIT19	216	#define EFI_ACPI_4_0_FORCE_APIC_PHYSICAL_DESTINATION_MODE BIT19
212		217
213	///	218	///
214	/// Firmware ACPI Control Structure	219	/// Firmware ACPI Control Structure
215	///	220	///
216	typedef struct {	221	typedef struct {
217	UINT32 Signature;	222	UINT32 Signature;
218	UINT32 Length;	223	UINT32 Length;
219	UINT32 HardwareSignature;	224	UINT32 HardwareSignature;
220	UINT32 FirmwareWakingVector;	225	UINT32 FirmwareWakingVector;
221	UINT32 GlobalLock;	226	UINT32 GlobalLock;
222	UINT32 Flags;	227	UINT32 Flags;
223	UINT64 XFirmwareWakingVector;	228	UINT64 XFirmwareWakingVector;
224	UINT8 Version;	229	UINT8 Version;
225	UINT8 Reserved0[3];	230	UINT8 Reserved0[3];
226	UINT32 OspmFlags;	231	UINT32 OspmFlags;
227	UINT8 Reserved1[24];	232	UINT8 Reserved1[24];
228	} EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE;	233	} EFI_ACPI_4_0_FIRMWARE_ACPI_CONTROL_STRUCTURE;
229		234
230	///	235	///
Lines 236-249 typedef struct { Link Here
236	/// Firmware Control Structure Feature Flags	241	/// Firmware Control Structure Feature Flags
237	/// All other bits are reserved and must be set to 0.	242	/// All other bits are reserved and must be set to 0.
238	///	243	///
239	#define EFI_ACPI_4_0_S4BIOS_F BIT0	244	#define EFI_ACPI_4_0_S4BIOS_F BIT0
240	#define EFI_ACPI_4_0_64BIT_WAKE_SUPPORTED_F BIT1	245	#define EFI_ACPI_4_0_64BIT_WAKE_SUPPORTED_F BIT1
241		246
242	///	247	///
243	/// OSPM Enabled Firmware Control Structure Flags	248	/// OSPM Enabled Firmware Control Structure Flags
244	/// All other bits are reserved and must be set to 0.	249	/// All other bits are reserved and must be set to 0.
245	///	250	///
246	#define EFI_ACPI_4_0_OSPM_64BIT_WAKE__F BIT0	251	#define EFI_ACPI_4_0_OSPM_64BIT_WAKE__F BIT0
247		252
248	//	253	//
249	// Differentiated System Description Table,	254	// Differentiated System Description Table,
Lines 252-280 typedef struct { Link Here
252	// no definition needed as they are common description table header, the same with	257	// no definition needed as they are common description table header, the same with
253	// EFI_ACPI_DESCRIPTION_HEADER, followed by a definition block.	258	// EFI_ACPI_DESCRIPTION_HEADER, followed by a definition block.
254	//	259	//
255	#define EFI_ACPI_4_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_REVISION 0x02	260	#define EFI_ACPI_4_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_REVISION 0x02
256	#define EFI_ACPI_4_0_SECONDARY_SYSTEM_DESCRIPTION_TABLE_REVISION 0x02	261	#define EFI_ACPI_4_0_SECONDARY_SYSTEM_DESCRIPTION_TABLE_REVISION 0x02
257		262
258	///	263	///
259	/// Multiple APIC Description Table header definition. The rest of the table	264	/// Multiple APIC Description Table header definition. The rest of the table
260	/// must be defined in a platform specific manner.	265	/// must be defined in a platform specific manner.
261	///	266	///
262	typedef struct {	267	typedef struct {
263	EFI_ACPI_DESCRIPTION_HEADER Header;	268	EFI_ACPI_DESCRIPTION_HEADER Header;
264	UINT32 LocalApicAddress;	269	UINT32 LocalApicAddress;
265	UINT32 Flags;	270	UINT32 Flags;
266	} EFI_ACPI_4_0_MULTIPLE_APIC_DESCRIPTION_TABLE_HEADER;	271	} EFI_ACPI_4_0_MULTIPLE_APIC_DESCRIPTION_TABLE_HEADER;
267		272
268	///	273	///
269	/// MADT Revision (as defined in ACPI 4.0 spec.)	274	/// MADT Revision (as defined in ACPI 4.0 spec.)
270	///	275	///
271	#define EFI_ACPI_4_0_MULTIPLE_APIC_DESCRIPTION_TABLE_REVISION 0x03	276	#define EFI_ACPI_4_0_MULTIPLE_APIC_DESCRIPTION_TABLE_REVISION 0x03
272		277
273	///	278	///
274	/// Multiple APIC Flags	279	/// Multiple APIC Flags
275	/// All other bits are reserved and must be set to 0.	280	/// All other bits are reserved and must be set to 0.
276	///	281	///
277	#define EFI_ACPI_4_0_PCAT_COMPAT BIT0	282	#define EFI_ACPI_4_0_PCAT_COMPAT BIT0
278		283
279	//	284	//
280	// Multiple APIC Description Table APIC structure types	285	// Multiple APIC Description Table APIC structure types
Lines 301-357 typedef struct { Link Here
301	/// Processor Local APIC Structure Definition	306	/// Processor Local APIC Structure Definition
302	///	307	///
303	typedef struct {	308	typedef struct {
304	UINT8 Type;	309	UINT8 Type;
305	UINT8 Length;	310	UINT8 Length;
306	UINT8 AcpiProcessorId;	311	UINT8 AcpiProcessorId;
307	UINT8 ApicId;	312	UINT8 ApicId;
308	UINT32 Flags;	313	UINT32 Flags;
309	} EFI_ACPI_4_0_PROCESSOR_LOCAL_APIC_STRUCTURE;	314	} EFI_ACPI_4_0_PROCESSOR_LOCAL_APIC_STRUCTURE;
310		315
311	///	316	///
312	/// Local APIC Flags. All other bits are reserved and must be 0.	317	/// Local APIC Flags. All other bits are reserved and must be 0.
313	///	318	///
314	#define EFI_ACPI_4_0_LOCAL_APIC_ENABLED BIT0	319	#define EFI_ACPI_4_0_LOCAL_APIC_ENABLED BIT0
315		320
316	///	321	///
317	/// IO APIC Structure	322	/// IO APIC Structure
318	///	323	///
319	typedef struct {	324	typedef struct {
320	UINT8 Type;	325	UINT8 Type;
321	UINT8 Length;	326	UINT8 Length;
322	UINT8 IoApicId;	327	UINT8 IoApicId;
323	UINT8 Reserved;	328	UINT8 Reserved;
324	UINT32 IoApicAddress;	329	UINT32 IoApicAddress;
325	UINT32 GlobalSystemInterruptBase;	330	UINT32 GlobalSystemInterruptBase;
326	} EFI_ACPI_4_0_IO_APIC_STRUCTURE;	331	} EFI_ACPI_4_0_IO_APIC_STRUCTURE;
327		332
328	///	333	///
329	/// Interrupt Source Override Structure	334	/// Interrupt Source Override Structure
330	///	335	///
331	typedef struct {	336	typedef struct {
332	UINT8 Type;	337	UINT8 Type;
333	UINT8 Length;	338	UINT8 Length;
334	UINT8 Bus;	339	UINT8 Bus;
335	UINT8 Source;	340	UINT8 Source;
336	UINT32 GlobalSystemInterrupt;	341	UINT32 GlobalSystemInterrupt;
337	UINT16 Flags;	342	UINT16 Flags;
338	} EFI_ACPI_4_0_INTERRUPT_SOURCE_OVERRIDE_STRUCTURE;	343	} EFI_ACPI_4_0_INTERRUPT_SOURCE_OVERRIDE_STRUCTURE;
339		344
340	///	345	///
341	/// Platform Interrupt Sources Structure Definition	346	/// Platform Interrupt Sources Structure Definition
342	///	347	///
343	typedef struct {	348	typedef struct {
344	UINT8 Type;	349	UINT8 Type;
345	UINT8 Length;	350	UINT8 Length;
346	UINT16 Flags;	351	UINT16 Flags;
347	UINT8 InterruptType;	352	UINT8 InterruptType;
348	UINT8 ProcessorId;	353	UINT8 ProcessorId;
349	UINT8 ProcessorEid;	354	UINT8 ProcessorEid;
350	UINT8 IoSapicVector;	355	UINT8 IoSapicVector;
351	UINT32 GlobalSystemInterrupt;	356	UINT32 GlobalSystemInterrupt;
352	UINT32 PlatformInterruptSourceFlags;	357	UINT32 PlatformInterruptSourceFlags;
353	UINT8 CpeiProcessorOverride;	358	UINT8 CpeiProcessorOverride;
354	UINT8 Reserved[31];	359	UINT8 Reserved[31];
355	} EFI_ACPI_4_0_PLATFORM_INTERRUPT_APIC_STRUCTURE;	360	} EFI_ACPI_4_0_PLATFORM_INTERRUPT_APIC_STRUCTURE;
356		361
357	//	362	//
Lines 365-407 typedef struct { Link Here
365	/// Non-Maskable Interrupt Source Structure	370	/// Non-Maskable Interrupt Source Structure
366	///	371	///
367	typedef struct {	372	typedef struct {
368	UINT8 Type;	373	UINT8 Type;
369	UINT8 Length;	374	UINT8 Length;
370	UINT16 Flags;	375	UINT16 Flags;
371	UINT32 GlobalSystemInterrupt;	376	UINT32 GlobalSystemInterrupt;
372	} EFI_ACPI_4_0_NON_MASKABLE_INTERRUPT_SOURCE_STRUCTURE;	377	} EFI_ACPI_4_0_NON_MASKABLE_INTERRUPT_SOURCE_STRUCTURE;
373		378
374	///	379	///
375	/// Local APIC NMI Structure	380	/// Local APIC NMI Structure
376	///	381	///
377	typedef struct {	382	typedef struct {
378	UINT8 Type;	383	UINT8 Type;
379	UINT8 Length;	384	UINT8 Length;
380	UINT8 AcpiProcessorId;	385	UINT8 AcpiProcessorId;
381	UINT16 Flags;	386	UINT16 Flags;
382	UINT8 LocalApicLint;	387	UINT8 LocalApicLint;
383	} EFI_ACPI_4_0_LOCAL_APIC_NMI_STRUCTURE;	388	} EFI_ACPI_4_0_LOCAL_APIC_NMI_STRUCTURE;
384		389
385	///	390	///
386	/// Local APIC Address Override Structure	391	/// Local APIC Address Override Structure
387	///	392	///
388	typedef struct {	393	typedef struct {
389	UINT8 Type;	394	UINT8 Type;
390	UINT8 Length;	395	UINT8 Length;
391	UINT16 Reserved;	396	UINT16 Reserved;
392	UINT64 LocalApicAddress;	397	UINT64 LocalApicAddress;
393	} EFI_ACPI_4_0_LOCAL_APIC_ADDRESS_OVERRIDE_STRUCTURE;	398	} EFI_ACPI_4_0_LOCAL_APIC_ADDRESS_OVERRIDE_STRUCTURE;
394		399
395	///	400	///
396	/// IO SAPIC Structure	401	/// IO SAPIC Structure
397	///	402	///
398	typedef struct {	403	typedef struct {
399	UINT8 Type;	404	UINT8 Type;
400	UINT8 Length;	405	UINT8 Length;
401	UINT8 IoApicId;	406	UINT8 IoApicId;
402	UINT8 Reserved;	407	UINT8 Reserved;
403	UINT32 GlobalSystemInterruptBase;	408	UINT32 GlobalSystemInterruptBase;
404	UINT64 IoSapicAddress;	409	UINT64 IoSapicAddress;
405	} EFI_ACPI_4_0_IO_SAPIC_STRUCTURE;	410	} EFI_ACPI_4_0_IO_SAPIC_STRUCTURE;
406		411
407	///	412	///
Lines 409-483 typedef struct { Link Here
409	/// This struct followed by a null-terminated ASCII string - ACPI Processor UID String	414	/// This struct followed by a null-terminated ASCII string - ACPI Processor UID String
410	///	415	///
411	typedef struct {	416	typedef struct {
412	UINT8 Type;	417	UINT8 Type;
413	UINT8 Length;	418	UINT8 Length;
414	UINT8 AcpiProcessorId;	419	UINT8 AcpiProcessorId;
415	UINT8 LocalSapicId;	420	UINT8 LocalSapicId;
416	UINT8 LocalSapicEid;	421	UINT8 LocalSapicEid;
417	UINT8 Reserved[3];	422	UINT8 Reserved[3];
418	UINT32 Flags;	423	UINT32 Flags;
419	UINT32 ACPIProcessorUIDValue;	424	UINT32 ACPIProcessorUIDValue;
420	} EFI_ACPI_4_0_PROCESSOR_LOCAL_SAPIC_STRUCTURE;	425	} EFI_ACPI_4_0_PROCESSOR_LOCAL_SAPIC_STRUCTURE;
421		426
422	///	427	///
423	/// Platform Interrupt Sources Structure	428	/// Platform Interrupt Sources Structure
424	///	429	///
425	typedef struct {	430	typedef struct {
426	UINT8 Type;	431	UINT8 Type;
427	UINT8 Length;	432	UINT8 Length;
428	UINT16 Flags;	433	UINT16 Flags;
429	UINT8 InterruptType;	434	UINT8 InterruptType;
430	UINT8 ProcessorId;	435	UINT8 ProcessorId;
431	UINT8 ProcessorEid;	436	UINT8 ProcessorEid;
432	UINT8 IoSapicVector;	437	UINT8 IoSapicVector;
433	UINT32 GlobalSystemInterrupt;	438	UINT32 GlobalSystemInterrupt;
434	UINT32 PlatformInterruptSourceFlags;	439	UINT32 PlatformInterruptSourceFlags;
435	} EFI_ACPI_4_0_PLATFORM_INTERRUPT_SOURCES_STRUCTURE;	440	} EFI_ACPI_4_0_PLATFORM_INTERRUPT_SOURCES_STRUCTURE;
436		441
437	///	442	///
438	/// Platform Interrupt Source Flags.	443	/// Platform Interrupt Source Flags.
439	/// All other bits are reserved and must be set to 0.	444	/// All other bits are reserved and must be set to 0.
440	///	445	///
441	#define EFI_ACPI_4_0_CPEI_PROCESSOR_OVERRIDE BIT0	446	#define EFI_ACPI_4_0_CPEI_PROCESSOR_OVERRIDE BIT0
442		447
443	///	448	///
444	/// Processor Local x2APIC Structure Definition	449	/// Processor Local x2APIC Structure Definition
445	///	450	///
446	typedef struct {	451	typedef struct {
447	UINT8 Type;	452	UINT8 Type;
448	UINT8 Length;	453	UINT8 Length;
449	UINT8 Reserved[2];	454	UINT8 Reserved[2];
450	UINT32 X2ApicId;	455	UINT32 X2ApicId;
451	UINT32 Flags;	456	UINT32 Flags;
452	UINT32 AcpiProcessorUid;	457	UINT32 AcpiProcessorUid;
453	} EFI_ACPI_4_0_PROCESSOR_LOCAL_X2APIC_STRUCTURE;	458	} EFI_ACPI_4_0_PROCESSOR_LOCAL_X2APIC_STRUCTURE;
454		459
455	///	460	///
456	/// Local x2APIC NMI Structure	461	/// Local x2APIC NMI Structure
457	///	462	///
458	typedef struct {	463	typedef struct {
459	UINT8 Type;	464	UINT8 Type;
460	UINT8 Length;	465	UINT8 Length;
461	UINT16 Flags;	466	UINT16 Flags;
462	UINT32 AcpiProcessorUid;	467	UINT32 AcpiProcessorUid;
463	UINT8 LocalX2ApicLint;	468	UINT8 LocalX2ApicLint;
464	UINT8 Reserved[3];	469	UINT8 Reserved[3];
465	} EFI_ACPI_4_0_LOCAL_X2APIC_NMI_STRUCTURE;	470	} EFI_ACPI_4_0_LOCAL_X2APIC_NMI_STRUCTURE;
466		471
467	///	472	///
468	/// Smart Battery Description Table (SBST)	473	/// Smart Battery Description Table (SBST)
469	///	474	///
470	typedef struct {	475	typedef struct {
471	EFI_ACPI_DESCRIPTION_HEADER Header;	476	EFI_ACPI_DESCRIPTION_HEADER Header;
472	UINT32 WarningEnergyLevel;	477	UINT32 WarningEnergyLevel;
473	UINT32 LowEnergyLevel;	478	UINT32 LowEnergyLevel;
474	UINT32 CriticalEnergyLevel;	479	UINT32 CriticalEnergyLevel;
475	} EFI_ACPI_4_0_SMART_BATTERY_DESCRIPTION_TABLE;	480	} EFI_ACPI_4_0_SMART_BATTERY_DESCRIPTION_TABLE;
476		481
477	///	482	///
478	/// SBST Version (as defined in ACPI 4.0 spec.)	483	/// SBST Version (as defined in ACPI 4.0 spec.)
479	///	484	///
480	#define EFI_ACPI_4_0_SMART_BATTERY_DESCRIPTION_TABLE_REVISION 0x01	485	#define EFI_ACPI_4_0_SMART_BATTERY_DESCRIPTION_TABLE_REVISION 0x01
481		486
482	///	487	///
483	/// Embedded Controller Boot Resources Table (ECDT)	488	/// Embedded Controller Boot Resources Table (ECDT)
Lines 485-495 typedef struct { Link Here
485	/// a fully qualified reference to the name space object.	490	/// a fully qualified reference to the name space object.
486	///	491	///
487	typedef struct {	492	typedef struct {
488	EFI_ACPI_DESCRIPTION_HEADER Header;	493	EFI_ACPI_DESCRIPTION_HEADER Header;
489	EFI_ACPI_4_0_GENERIC_ADDRESS_STRUCTURE EcControl;	494	EFI_ACPI_4_0_GENERIC_ADDRESS_STRUCTURE EcControl;
490	EFI_ACPI_4_0_GENERIC_ADDRESS_STRUCTURE EcData;	495	EFI_ACPI_4_0_GENERIC_ADDRESS_STRUCTURE EcData;
491	UINT32 Uid;	496	UINT32 Uid;
492	UINT8 GpeBit;	497	UINT8 GpeBit;
493	} EFI_ACPI_4_0_EMBEDDED_CONTROLLER_BOOT_RESOURCES_TABLE;	498	} EFI_ACPI_4_0_EMBEDDED_CONTROLLER_BOOT_RESOURCES_TABLE;
494		499
495	///	500	///
Lines 502-510 typedef struct { Link Here
502	/// must be defined in a platform specific manner.	507	/// must be defined in a platform specific manner.
503	///	508	///
504	typedef struct {	509	typedef struct {
505	EFI_ACPI_DESCRIPTION_HEADER Header;	510	EFI_ACPI_DESCRIPTION_HEADER Header;
506	UINT32 Reserved1; ///< Must be set to 1	511	UINT32 Reserved1; ///< Must be set to 1
507	UINT64 Reserved2;	512	UINT64 Reserved2;
508	} EFI_ACPI_4_0_SYSTEM_RESOURCE_AFFINITY_TABLE_HEADER;	513	} EFI_ACPI_4_0_SYSTEM_RESOURCE_AFFINITY_TABLE_HEADER;
509		514
510	///	515	///
Lines 525-581 typedef struct { Link Here
525	/// Processor Local APIC/SAPIC Affinity Structure Definition	530	/// Processor Local APIC/SAPIC Affinity Structure Definition
526	///	531	///
527	typedef struct {	532	typedef struct {
528	UINT8 Type;	533	UINT8 Type;
529	UINT8 Length;	534	UINT8 Length;
530	UINT8 ProximityDomain7To0;	535	UINT8 ProximityDomain7To0;
531	UINT8 ApicId;	536	UINT8 ApicId;
532	UINT32 Flags;	537	UINT32 Flags;
533	UINT8 LocalSapicEid;	538	UINT8 LocalSapicEid;
534	UINT8 ProximityDomain31To8[3];	539	UINT8 ProximityDomain31To8[3];
535	UINT32 ClockDomain;	540	UINT32 ClockDomain;
536	} EFI_ACPI_4_0_PROCESSOR_LOCAL_APIC_SAPIC_AFFINITY_STRUCTURE;	541	} EFI_ACPI_4_0_PROCESSOR_LOCAL_APIC_SAPIC_AFFINITY_STRUCTURE;
537		542
538	///	543	///
539	/// Local APIC/SAPIC Flags. All other bits are reserved and must be 0.	544	/// Local APIC/SAPIC Flags. All other bits are reserved and must be 0.
540	///	545	///
541	#define EFI_ACPI_4_0_PROCESSOR_LOCAL_APIC_SAPIC_ENABLED (1 << 0)	546	#define EFI_ACPI_4_0_PROCESSOR_LOCAL_APIC_SAPIC_ENABLED (1 << 0)
542		547
543	///	548	///
544	/// Memory Affinity Structure Definition	549	/// Memory Affinity Structure Definition
545	///	550	///
546	typedef struct {	551	typedef struct {
547	UINT8 Type;	552	UINT8 Type;
548	UINT8 Length;	553	UINT8 Length;
549	UINT32 ProximityDomain;	554	UINT32 ProximityDomain;
550	UINT16 Reserved1;	555	UINT16 Reserved1;
551	UINT32 AddressBaseLow;	556	UINT32 AddressBaseLow;
552	UINT32 AddressBaseHigh;	557	UINT32 AddressBaseHigh;
553	UINT32 LengthLow;	558	UINT32 LengthLow;
554	UINT32 LengthHigh;	559	UINT32 LengthHigh;
555	UINT32 Reserved2;	560	UINT32 Reserved2;
556	UINT32 Flags;	561	UINT32 Flags;
557	UINT64 Reserved3;	562	UINT64 Reserved3;
558	} EFI_ACPI_4_0_MEMORY_AFFINITY_STRUCTURE;	563	} EFI_ACPI_4_0_MEMORY_AFFINITY_STRUCTURE;
559		564
560	//	565	//
561	// Memory Flags. All other bits are reserved and must be 0.	566	// Memory Flags. All other bits are reserved and must be 0.
562	//	567	//
563	#define EFI_ACPI_4_0_MEMORY_ENABLED (1 << 0)	568	#define EFI_ACPI_4_0_MEMORY_ENABLED (1 << 0)
564	#define EFI_ACPI_4_0_MEMORY_HOT_PLUGGABLE (1 << 1)	569	#define EFI_ACPI_4_0_MEMORY_HOT_PLUGGABLE (1 << 1)
565	#define EFI_ACPI_4_0_MEMORY_NONVOLATILE (1 << 2)	570	#define EFI_ACPI_4_0_MEMORY_NONVOLATILE (1 << 2)
566		571
567	///	572	///
568	/// Processor Local x2APIC Affinity Structure Definition	573	/// Processor Local x2APIC Affinity Structure Definition
569	///	574	///
570	typedef struct {	575	typedef struct {
571	UINT8 Type;	576	UINT8 Type;
572	UINT8 Length;	577	UINT8 Length;
573	UINT8 Reserved1[2];	578	UINT8 Reserved1[2];
574	UINT32 ProximityDomain;	579	UINT32 ProximityDomain;
575	UINT32 X2ApicId;	580	UINT32 X2ApicId;
576	UINT32 Flags;	581	UINT32 Flags;
577	UINT32 ClockDomain;	582	UINT32 ClockDomain;
578	UINT8 Reserved2[4];	583	UINT8 Reserved2[4];
579	} EFI_ACPI_4_0_PROCESSOR_LOCAL_X2APIC_AFFINITY_STRUCTURE;	584	} EFI_ACPI_4_0_PROCESSOR_LOCAL_X2APIC_AFFINITY_STRUCTURE;
580		585
581	///	586	///
Lines 583-590 typedef struct { Link Here
583	/// The rest of the table is a matrix.	588	/// The rest of the table is a matrix.
584	///	589	///
585	typedef struct {	590	typedef struct {
586	EFI_ACPI_DESCRIPTION_HEADER Header;	591	EFI_ACPI_DESCRIPTION_HEADER Header;
587	UINT64 NumberOfSystemLocalities;	592	UINT64 NumberOfSystemLocalities;
588	} EFI_ACPI_4_0_SYSTEM_LOCALITY_DISTANCE_INFORMATION_TABLE_HEADER;	593	} EFI_ACPI_4_0_SYSTEM_LOCALITY_DISTANCE_INFORMATION_TABLE_HEADER;
589		594
590	///	595	///
Lines 596-609 typedef struct { Link Here
596	/// Corrected Platform Error Polling Table (CPEP)	601	/// Corrected Platform Error Polling Table (CPEP)
597	///	602	///
598	typedef struct {	603	typedef struct {
599	EFI_ACPI_DESCRIPTION_HEADER Header;	604	EFI_ACPI_DESCRIPTION_HEADER Header;
600	UINT8 Reserved[8];	605	UINT8 Reserved[8];
601	} EFI_ACPI_4_0_CORRECTED_PLATFORM_ERROR_POLLING_TABLE_HEADER;	606	} EFI_ACPI_4_0_CORRECTED_PLATFORM_ERROR_POLLING_TABLE_HEADER;
602		607
603	///	608	///
604	/// CPEP Version (as defined in ACPI 4.0 spec.)	609	/// CPEP Version (as defined in ACPI 4.0 spec.)
605	///	610	///
606	#define EFI_ACPI_4_0_CORRECTED_PLATFORM_ERROR_POLLING_TABLE_REVISION 0x01	611	#define EFI_ACPI_4_0_CORRECTED_PLATFORM_ERROR_POLLING_TABLE_REVISION 0x01
607		612
608	//	613	//
609	// CPEP processor structure types.	614	// CPEP processor structure types.
Lines 614-695 typedef struct { Link Here
614	/// Corrected Platform Error Polling Processor Structure Definition	619	/// Corrected Platform Error Polling Processor Structure Definition
615	///	620	///
616	typedef struct {	621	typedef struct {
617	UINT8 Type;	622	UINT8 Type;
618	UINT8 Length;	623	UINT8 Length;
619	UINT8 ProcessorId;	624	UINT8 ProcessorId;
620	UINT8 ProcessorEid;	625	UINT8 ProcessorEid;
621	UINT32 PollingInterval;	626	UINT32 PollingInterval;
622	} EFI_ACPI_4_0_CPEP_PROCESSOR_APIC_SAPIC_STRUCTURE;	627	} EFI_ACPI_4_0_CPEP_PROCESSOR_APIC_SAPIC_STRUCTURE;
623		628
624	///	629	///
625	/// Maximum System Characteristics Table (MSCT)	630	/// Maximum System Characteristics Table (MSCT)
626	///	631	///
627	typedef struct {	632	typedef struct {
628	EFI_ACPI_DESCRIPTION_HEADER Header;	633	EFI_ACPI_DESCRIPTION_HEADER Header;
629	UINT32 OffsetProxDomInfo;	634	UINT32 OffsetProxDomInfo;
630	UINT32 MaximumNumberOfProximityDomains;	635	UINT32 MaximumNumberOfProximityDomains;
631	UINT32 MaximumNumberOfClockDomains;	636	UINT32 MaximumNumberOfClockDomains;
632	UINT64 MaximumPhysicalAddress;	637	UINT64 MaximumPhysicalAddress;
633	} EFI_ACPI_4_0_MAXIMUM_SYSTEM_CHARACTERISTICS_TABLE_HEADER;	638	} EFI_ACPI_4_0_MAXIMUM_SYSTEM_CHARACTERISTICS_TABLE_HEADER;
634		639
635	///	640	///
636	/// MSCT Version (as defined in ACPI 4.0 spec.)	641	/// MSCT Version (as defined in ACPI 4.0 spec.)
637	///	642	///
638	#define EFI_ACPI_4_0_MAXIMUM_SYSTEM_CHARACTERISTICS_TABLE_REVISION 0x01	643	#define EFI_ACPI_4_0_MAXIMUM_SYSTEM_CHARACTERISTICS_TABLE_REVISION 0x01
639		644
640	///	645	///
641	/// Maximum Proximity Domain Information Structure Definition	646	/// Maximum Proximity Domain Information Structure Definition
642	///	647	///
643	typedef struct {	648	typedef struct {
644	UINT8 Revision;	649	UINT8 Revision;
645	UINT8 Length;	650	UINT8 Length;
646	UINT32 ProximityDomainRangeLow;	651	UINT32 ProximityDomainRangeLow;
647	UINT32 ProximityDomainRangeHigh;	652	UINT32 ProximityDomainRangeHigh;
648	UINT32 MaximumProcessorCapacity;	653	UINT32 MaximumProcessorCapacity;
649	UINT64 MaximumMemoryCapacity;	654	UINT64 MaximumMemoryCapacity;
650	} EFI_ACPI_4_0_MAXIMUM_PROXIMITY_DOMAIN_INFORMATION_STRUCTURE;	655	} EFI_ACPI_4_0_MAXIMUM_PROXIMITY_DOMAIN_INFORMATION_STRUCTURE;
651		656
652	///	657	///
653	/// Boot Error Record Table (BERT)	658	/// Boot Error Record Table (BERT)
654	///	659	///
655	typedef struct {	660	typedef struct {
656	EFI_ACPI_DESCRIPTION_HEADER Header;	661	EFI_ACPI_DESCRIPTION_HEADER Header;
657	UINT32 BootErrorRegionLength;	662	UINT32 BootErrorRegionLength;
658	UINT64 BootErrorRegion;	663	UINT64 BootErrorRegion;
659	} EFI_ACPI_4_0_BOOT_ERROR_RECORD_TABLE_HEADER;	664	} EFI_ACPI_4_0_BOOT_ERROR_RECORD_TABLE_HEADER;
660		665
661	///	666	///
662	/// BERT Version (as defined in ACPI 4.0 spec.)	667	/// BERT Version (as defined in ACPI 4.0 spec.)
663	///	668	///
664	#define EFI_ACPI_4_0_BOOT_ERROR_RECORD_TABLE_REVISION 0x01	669	#define EFI_ACPI_4_0_BOOT_ERROR_RECORD_TABLE_REVISION 0x01
665		670
666	///	671	///
667	/// Boot Error Region Block Status Definition	672	/// Boot Error Region Block Status Definition
668	///	673	///
669	typedef struct {	674	typedef struct {
670	UINT32 UncorrectableErrorValid:1;	675	UINT32 UncorrectableErrorValid : 1;
671	UINT32 CorrectableErrorValid:1;	676	UINT32 CorrectableErrorValid : 1;
672	UINT32 MultipleUncorrectableErrors:1;	677	UINT32 MultipleUncorrectableErrors : 1;
673	UINT32 MultipleCorrectableErrors:1;	678	UINT32 MultipleCorrectableErrors : 1;
674	UINT32 ErrorDataEntryCount:10;	679	UINT32 ErrorDataEntryCount : 10;
675	UINT32 Reserved:18;	680	UINT32 Reserved : 18;
676	} EFI_ACPI_4_0_ERROR_BLOCK_STATUS;	681	} EFI_ACPI_4_0_ERROR_BLOCK_STATUS;
677		682
678	///	683	///
679	/// Boot Error Region Definition	684	/// Boot Error Region Definition
680	///	685	///
681	typedef struct {	686	typedef struct {
682	EFI_ACPI_4_0_ERROR_BLOCK_STATUS BlockStatus;	687	EFI_ACPI_4_0_ERROR_BLOCK_STATUS BlockStatus;
683	UINT32 RawDataOffset;	688	UINT32 RawDataOffset;
684	UINT32 RawDataLength;	689	UINT32 RawDataLength;
685	UINT32 DataLength;	690	UINT32 DataLength;
686	UINT32 ErrorSeverity;	691	UINT32 ErrorSeverity;
687	} EFI_ACPI_4_0_BOOT_ERROR_REGION_STRUCTURE;	692	} EFI_ACPI_4_0_BOOT_ERROR_REGION_STRUCTURE;
688		693
689	//	694	//
690	// Boot Error Severity types	695	// Boot Error Severity types
691	//	696	//
692	#define EFI_ACPI_4_0_ERROR_SEVERITY_CORRECTABLE 0x00	697	#define EFI_ACPI_4_0_ERROR_SEVERITY_CORRECTABLE 0x00
		698	#define EFI_ACPI_4_0_ERROR_SEVERITY_RECOVERABLE 0x00
693	#define EFI_ACPI_4_0_ERROR_SEVERITY_FATAL 0x01	699	#define EFI_ACPI_4_0_ERROR_SEVERITY_FATAL 0x01
694	#define EFI_ACPI_4_0_ERROR_SEVERITY_CORRECTED 0x02	700	#define EFI_ACPI_4_0_ERROR_SEVERITY_CORRECTED 0x02
695	#define EFI_ACPI_4_0_ERROR_SEVERITY_NONE 0x03	701	#define EFI_ACPI_4_0_ERROR_SEVERITY_NONE 0x03
Lines 698-711 typedef struct { Link Here
698	/// Generic Error Data Entry Definition	704	/// Generic Error Data Entry Definition
699	///	705	///
700	typedef struct {	706	typedef struct {
701	UINT8 SectionType[16];	707	UINT8 SectionType[16];
702	UINT32 ErrorSeverity;	708	UINT32 ErrorSeverity;
703	UINT16 Revision;	709	UINT16 Revision;
704	UINT8 ValidationBits;	710	UINT8 ValidationBits;
705	UINT8 Flags;	711	UINT8 Flags;
706	UINT32 ErrorDataLength;	712	UINT32 ErrorDataLength;
707	UINT8 FruId[16];	713	UINT8 FruId[16];
708	UINT8 FruText[20];	714	UINT8 FruText[20];
709	} EFI_ACPI_4_0_GENERIC_ERROR_DATA_ENTRY_STRUCTURE;	715	} EFI_ACPI_4_0_GENERIC_ERROR_DATA_ENTRY_STRUCTURE;
710		716
711	///	717	///
Lines 717-730 typedef struct { Link Here
717	/// HEST - Hardware Error Source Table	723	/// HEST - Hardware Error Source Table
718	///	724	///
719	typedef struct {	725	typedef struct {
720	EFI_ACPI_DESCRIPTION_HEADER Header;	726	EFI_ACPI_DESCRIPTION_HEADER Header;
721	UINT32 ErrorSourceCount;	727	UINT32 ErrorSourceCount;
722	} EFI_ACPI_4_0_HARDWARE_ERROR_SOURCE_TABLE_HEADER;	728	} EFI_ACPI_4_0_HARDWARE_ERROR_SOURCE_TABLE_HEADER;
723		729
724	///	730	///
725	/// HEST Version (as defined in ACPI 4.0 spec.)	731	/// HEST Version (as defined in ACPI 4.0 spec.)
726	///	732	///
727	#define EFI_ACPI_4_0_HARDWARE_ERROR_SOURCE_TABLE_REVISION 0x01	733	#define EFI_ACPI_4_0_HARDWARE_ERROR_SOURCE_TABLE_REVISION 0x01
728		734
729	//	735	//
730	// Error Source structure types.	736	// Error Source structure types.
Lines 740-1122 typedef struct { Link Here
740	//	746	//
741	// Error Source structure flags.	747	// Error Source structure flags.
742	//	748	//
743	#define EFI_ACPI_4_0_ERROR_SOURCE_FLAG_FIRMWARE_FIRST (1 << 0)	749	#define EFI_ACPI_4_0_ERROR_SOURCE_FLAG_FIRMWARE_FIRST (1 << 0)
744	#define EFI_ACPI_4_0_ERROR_SOURCE_FLAG_GLOBAL (1 << 1)	750	#define EFI_ACPI_4_0_ERROR_SOURCE_FLAG_GLOBAL (1 << 1)
745		751
746	///	752	///
747	/// IA-32 Architecture Machine Check Exception Structure Definition	753	/// IA-32 Architecture Machine Check Exception Structure Definition
748	///	754	///
749	typedef struct {	755	typedef struct {
750	UINT16 Type;	756	UINT16 Type;
751	UINT16 SourceId;	757	UINT16 SourceId;
752	UINT8 Reserved0[2];	758	UINT8 Reserved0[2];
753	UINT8 Flags;	759	UINT8 Flags;
754	UINT8 Enabled;	760	UINT8 Enabled;
755	UINT32 NumberOfRecordsToPreAllocate;	761	UINT32 NumberOfRecordsToPreAllocate;
756	UINT32 MaxSectionsPerRecord;	762	UINT32 MaxSectionsPerRecord;
757	UINT64 GlobalCapabilityInitData;	763	UINT64 GlobalCapabilityInitData;
758	UINT64 GlobalControlInitData;	764	UINT64 GlobalControlInitData;
759	UINT8 NumberOfHardwareBanks;	765	UINT8 NumberOfHardwareBanks;
760	UINT8 Reserved1[7];	766	UINT8 Reserved1[7];
761	} EFI_ACPI_4_0_IA32_ARCHITECTURE_MACHINE_CHECK_EXCEPTION_STRUCTURE;	767	} EFI_ACPI_4_0_IA32_ARCHITECTURE_MACHINE_CHECK_EXCEPTION_STRUCTURE;
762		768
763	///	769	///
764	/// IA-32 Architecture Machine Check Bank Structure Definition	770	/// IA-32 Architecture Machine Check Bank Structure Definition
765	///	771	///
766	typedef struct {	772	typedef struct {
767	UINT8 BankNumber;	773	UINT8 BankNumber;
768	UINT8 ClearStatusOnInitialization;	774	UINT8 ClearStatusOnInitialization;
769	UINT8 StatusDataFormat;	775	UINT8 StatusDataFormat;
770	UINT8 Reserved0;	776	UINT8 Reserved0;
771	UINT32 ControlRegisterMsrAddress;	777	UINT32 ControlRegisterMsrAddress;
772	UINT64 ControlInitData;	778	UINT64 ControlInitData;
773	UINT32 StatusRegisterMsrAddress;	779	UINT32 StatusRegisterMsrAddress;
774	UINT32 AddressRegisterMsrAddress;	780	UINT32 AddressRegisterMsrAddress;
775	UINT32 MiscRegisterMsrAddress;	781	UINT32 MiscRegisterMsrAddress;
776	} EFI_ACPI_4_0_IA32_ARCHITECTURE_MACHINE_CHECK_ERROR_BANK_STRUCTURE;	782	} EFI_ACPI_4_0_IA32_ARCHITECTURE_MACHINE_CHECK_ERROR_BANK_STRUCTURE;
777		783
778	///	784	///
779	/// IA-32 Architecture Machine Check Bank Structure MCA data format	785	/// IA-32 Architecture Machine Check Bank Structure MCA data format
780	///	786	///
781	#define EFI_ACPI_4_0_IA32_ARCHITECTURE_MACHINE_CHECK_ERROR_DATA_FORMAT_IA32 0x00	787	#define EFI_ACPI_4_0_IA32_ARCHITECTURE_MACHINE_CHECK_ERROR_DATA_FORMAT_IA32 0x00
782	#define EFI_ACPI_4_0_IA32_ARCHITECTURE_MACHINE_CHECK_ERROR_DATA_FORMAT_INTEL64 0x01	788	#define EFI_ACPI_4_0_IA32_ARCHITECTURE_MACHINE_CHECK_ERROR_DATA_FORMAT_INTEL64 0x01
783	#define EFI_ACPI_4_0_IA32_ARCHITECTURE_MACHINE_CHECK_ERROR_DATA_FORMAT_AMD64 0x02	789	#define EFI_ACPI_4_0_IA32_ARCHITECTURE_MACHINE_CHECK_ERROR_DATA_FORMAT_AMD64 0x02
784		790
785	//	791	//
786	// Hardware Error Notification types. All other values are reserved	792	// Hardware Error Notification types. All other values are reserved
787	//	793	//
788	#define EFI_ACPI_4_0_HARDWARE_ERROR_NOTIFICATION_POLLED 0x00	794	#define EFI_ACPI_4_0_HARDWARE_ERROR_NOTIFICATION_POLLED 0x00
789	#define EFI_ACPI_4_0_HARDWARE_ERROR_NOTIFICATION_EXTERNAL_INTERRUPT 0x01	795	#define EFI_ACPI_4_0_HARDWARE_ERROR_NOTIFICATION_EXTERNAL_INTERRUPT 0x01
790	#define EFI_ACPI_4_0_HARDWARE_ERROR_NOTIFICATION_LOCAL_INTERRUPT 0x02	796	#define EFI_ACPI_4_0_HARDWARE_ERROR_NOTIFICATION_LOCAL_INTERRUPT 0x02
791	#define EFI_ACPI_4_0_HARDWARE_ERROR_NOTIFICATION_SCI 0x03	797	#define EFI_ACPI_4_0_HARDWARE_ERROR_NOTIFICATION_SCI 0x03
792	#define EFI_ACPI_4_0_HARDWARE_ERROR_NOTIFICATION_NMI 0x04	798	#define EFI_ACPI_4_0_HARDWARE_ERROR_NOTIFICATION_NMI 0x04
793		799
794	///	800	///
795	/// Hardware Error Notification Configuration Write Enable Structure Definition	801	/// Hardware Error Notification Configuration Write Enable Structure Definition
796	///	802	///
797	typedef struct {	803	typedef struct {
798	UINT16 Type:1;	804	UINT16 Type : 1;
799	UINT16 PollInterval:1;	805	UINT16 PollInterval : 1;
800	UINT16 SwitchToPollingThresholdValue:1;	806	UINT16 SwitchToPollingThresholdValue : 1;
801	UINT16 SwitchToPollingThresholdWindow:1;	807	UINT16 SwitchToPollingThresholdWindow : 1;
802	UINT16 ErrorThresholdValue:1;	808	UINT16 ErrorThresholdValue : 1;
803	UINT16 ErrorThresholdWindow:1;	809	UINT16 ErrorThresholdWindow : 1;
804	UINT16 Reserved:10;	810	UINT16 Reserved : 10;
805	} EFI_ACPI_4_0_HARDWARE_ERROR_NOTIFICATION_CONFIGURATION_WRITE_ENABLE_STRUCTURE;	811	} EFI_ACPI_4_0_HARDWARE_ERROR_NOTIFICATION_CONFIGURATION_WRITE_ENABLE_STRUCTURE;
806		812
807	///	813	///
808	/// Hardware Error Notification Structure Definition	814	/// Hardware Error Notification Structure Definition
809	///	815	///
810	typedef struct {	816	typedef struct {
811	UINT8 Type;	817	UINT8 Type;
812	UINT8 Length;	818	UINT8 Length;
813	EFI_ACPI_4_0_HARDWARE_ERROR_NOTIFICATION_CONFIGURATION_WRITE_ENABLE_STRUCTURE ConfigurationWriteEnable;	819	EFI_ACPI_4_0_HARDWARE_ERROR_NOTIFICATION_CONFIGURATION_WRITE_ENABLE_STRUCTURE ConfigurationWriteEnable;
814	UINT32 PollInterval;	820	UINT32 PollInterval;
815	UINT32 Vector;	821	UINT32 Vector;
816	UINT32 SwitchToPollingThresholdValue;	822	UINT32 SwitchToPollingThresholdValue;
817	UINT32 SwitchToPollingThresholdWindow;	823	UINT32 SwitchToPollingThresholdWindow;
818	UINT32 ErrorThresholdValue;	824	UINT32 ErrorThresholdValue;
819	UINT32 ErrorThresholdWindow;	825	UINT32 ErrorThresholdWindow;
820	} EFI_ACPI_4_0_HARDWARE_ERROR_NOTIFICATION_STRUCTURE;	826	} EFI_ACPI_4_0_HARDWARE_ERROR_NOTIFICATION_STRUCTURE;
821		827
822	///	828	///
823	/// IA-32 Architecture Corrected Machine Check Structure Definition	829	/// IA-32 Architecture Corrected Machine Check Structure Definition
824	///	830	///
825	typedef struct {	831	typedef struct {
826	UINT16 Type;	832	UINT16 Type;
827	UINT16 SourceId;	833	UINT16 SourceId;
828	UINT8 Reserved0[2];	834	UINT8 Reserved0[2];
829	UINT8 Flags;	835	UINT8 Flags;
830	UINT8 Enabled;	836	UINT8 Enabled;
831	UINT32 NumberOfRecordsToPreAllocate;	837	UINT32 NumberOfRecordsToPreAllocate;
832	UINT32 MaxSectionsPerRecord;	838	UINT32 MaxSectionsPerRecord;
833	EFI_ACPI_4_0_HARDWARE_ERROR_NOTIFICATION_STRUCTURE NotificationStructure;	839	EFI_ACPI_4_0_HARDWARE_ERROR_NOTIFICATION_STRUCTURE NotificationStructure;
834	UINT8 NumberOfHardwareBanks;	840	UINT8 NumberOfHardwareBanks;
835	UINT8 Reserved1[3];	841	UINT8 Reserved1[3];
836	} EFI_ACPI_4_0_IA32_ARCHITECTURE_CORRECTED_MACHINE_CHECK_STRUCTURE;	842	} EFI_ACPI_4_0_IA32_ARCHITECTURE_CORRECTED_MACHINE_CHECK_STRUCTURE;
837		843
838	///	844	///
839	/// IA-32 Architecture NMI Error Structure Definition	845	/// IA-32 Architecture NMI Error Structure Definition
840	///	846	///
841	typedef struct {	847	typedef struct {
842	UINT16 Type;	848	UINT16 Type;
843	UINT16 SourceId;	849	UINT16 SourceId;
844	UINT8 Reserved0[2];	850	UINT8 Reserved0[2];
845	UINT32 NumberOfRecordsToPreAllocate;	851	UINT32 NumberOfRecordsToPreAllocate;
846	UINT32 MaxSectionsPerRecord;	852	UINT32 MaxSectionsPerRecord;
847	UINT32 MaxRawDataLength;	853	UINT32 MaxRawDataLength;
848	} EFI_ACPI_4_0_IA32_ARCHITECTURE_NMI_ERROR_STRUCTURE;	854	} EFI_ACPI_4_0_IA32_ARCHITECTURE_NMI_ERROR_STRUCTURE;
849		855
850	///	856	///
851	/// PCI Express Root Port AER Structure Definition	857	/// PCI Express Root Port AER Structure Definition
852	///	858	///
853	typedef struct {	859	typedef struct {
854	UINT16 Type;	860	UINT16 Type;
855	UINT16 SourceId;	861	UINT16 SourceId;
856	UINT8 Reserved0[2];	862	UINT8 Reserved0[2];
857	UINT8 Flags;	863	UINT8 Flags;
858	UINT8 Enabled;	864	UINT8 Enabled;
859	UINT32 NumberOfRecordsToPreAllocate;	865	UINT32 NumberOfRecordsToPreAllocate;
860	UINT32 MaxSectionsPerRecord;	866	UINT32 MaxSectionsPerRecord;
861	UINT32 Bus;	867	UINT32 Bus;
862	UINT16 Device;	868	UINT16 Device;
863	UINT16 Function;	869	UINT16 Function;
864	UINT16 DeviceControl;	870	UINT16 DeviceControl;
865	UINT8 Reserved1[2];	871	UINT8 Reserved1[2];
866	UINT32 UncorrectableErrorMask;	872	UINT32 UncorrectableErrorMask;
867	UINT32 UncorrectableErrorSeverity;	873	UINT32 UncorrectableErrorSeverity;
868	UINT32 CorrectableErrorMask;	874	UINT32 CorrectableErrorMask;
869	UINT32 AdvancedErrorCapabilitiesAndControl;	875	UINT32 AdvancedErrorCapabilitiesAndControl;
870	UINT32 RootErrorCommand;	876	UINT32 RootErrorCommand;
871	} EFI_ACPI_4_0_PCI_EXPRESS_ROOT_PORT_AER_STRUCTURE;	877	} EFI_ACPI_4_0_PCI_EXPRESS_ROOT_PORT_AER_STRUCTURE;
872		878
873	///	879	///
874	/// PCI Express Device AER Structure Definition	880	/// PCI Express Device AER Structure Definition
875	///	881	///
876	typedef struct {	882	typedef struct {
877	UINT16 Type;	883	UINT16 Type;
878	UINT16 SourceId;	884	UINT16 SourceId;
879	UINT8 Reserved0[2];	885	UINT8 Reserved0[2];
880	UINT8 Flags;	886	UINT8 Flags;
881	UINT8 Enabled;	887	UINT8 Enabled;
882	UINT32 NumberOfRecordsToPreAllocate;	888	UINT32 NumberOfRecordsToPreAllocate;
883	UINT32 MaxSectionsPerRecord;	889	UINT32 MaxSectionsPerRecord;
884	UINT32 Bus;	890	UINT32 Bus;
885	UINT16 Device;	891	UINT16 Device;
886	UINT16 Function;	892	UINT16 Function;
887	UINT16 DeviceControl;	893	UINT16 DeviceControl;
888	UINT8 Reserved1[2];	894	UINT8 Reserved1[2];
889	UINT32 UncorrectableErrorMask;	895	UINT32 UncorrectableErrorMask;
890	UINT32 UncorrectableErrorSeverity;	896	UINT32 UncorrectableErrorSeverity;
891	UINT32 CorrectableErrorMask;	897	UINT32 CorrectableErrorMask;
892	UINT32 AdvancedErrorCapabilitiesAndControl;	898	UINT32 AdvancedErrorCapabilitiesAndControl;
893	} EFI_ACPI_4_0_PCI_EXPRESS_DEVICE_AER_STRUCTURE;	899	} EFI_ACPI_4_0_PCI_EXPRESS_DEVICE_AER_STRUCTURE;
894		900
895	///	901	///
896	/// PCI Express Bridge AER Structure Definition	902	/// PCI Express Bridge AER Structure Definition
897	///	903	///
898	typedef struct {	904	typedef struct {
899	UINT16 Type;	905	UINT16 Type;
900	UINT16 SourceId;	906	UINT16 SourceId;
901	UINT8 Reserved0[2];	907	UINT8 Reserved0[2];
902	UINT8 Flags;	908	UINT8 Flags;
903	UINT8 Enabled;	909	UINT8 Enabled;
904	UINT32 NumberOfRecordsToPreAllocate;	910	UINT32 NumberOfRecordsToPreAllocate;
905	UINT32 MaxSectionsPerRecord;	911	UINT32 MaxSectionsPerRecord;
906	UINT32 Bus;	912	UINT32 Bus;
907	UINT16 Device;	913	UINT16 Device;
908	UINT16 Function;	914	UINT16 Function;
909	UINT16 DeviceControl;	915	UINT16 DeviceControl;
910	UINT8 Reserved1[2];	916	UINT8 Reserved1[2];
911	UINT32 UncorrectableErrorMask;	917	UINT32 UncorrectableErrorMask;
912	UINT32 UncorrectableErrorSeverity;	918	UINT32 UncorrectableErrorSeverity;
913	UINT32 CorrectableErrorMask;	919	UINT32 CorrectableErrorMask;
914	UINT32 AdvancedErrorCapabilitiesAndControl;	920	UINT32 AdvancedErrorCapabilitiesAndControl;
915	UINT32 SecondaryUncorrectableErrorMask;	921	UINT32 SecondaryUncorrectableErrorMask;
916	UINT32 SecondaryUncorrectableErrorSeverity;	922	UINT32 SecondaryUncorrectableErrorSeverity;
917	UINT32 SecondaryAdvancedErrorCapabilitiesAndControl;	923	UINT32 SecondaryAdvancedErrorCapabilitiesAndControl;
918	} EFI_ACPI_4_0_PCI_EXPRESS_BRIDGE_AER_STRUCTURE;	924	} EFI_ACPI_4_0_PCI_EXPRESS_BRIDGE_AER_STRUCTURE;
919		925
920	///	926	///
921	/// Generic Hardware Error Source Structure Definition	927	/// Generic Hardware Error Source Structure Definition
922	///	928	///
923	typedef struct {	929	typedef struct {
924	UINT16 Type;	930	UINT16 Type;
925	UINT16 SourceId;	931	UINT16 SourceId;
926	UINT16 RelatedSourceId;	932	UINT16 RelatedSourceId;
927	UINT8 Flags;	933	UINT8 Flags;
928	UINT8 Enabled;	934	UINT8 Enabled;
929	UINT32 NumberOfRecordsToPreAllocate;	935	UINT32 NumberOfRecordsToPreAllocate;
930	UINT32 MaxSectionsPerRecord;	936	UINT32 MaxSectionsPerRecord;
931	UINT32 MaxRawDataLength;	937	UINT32 MaxRawDataLength;
932	EFI_ACPI_4_0_GENERIC_ADDRESS_STRUCTURE ErrorStatusAddress;	938	EFI_ACPI_4_0_GENERIC_ADDRESS_STRUCTURE ErrorStatusAddress;
933	EFI_ACPI_4_0_HARDWARE_ERROR_NOTIFICATION_STRUCTURE NotificationStructure;	939	EFI_ACPI_4_0_HARDWARE_ERROR_NOTIFICATION_STRUCTURE NotificationStructure;
934	UINT32 ErrorStatusBlockLength;	940	UINT32 ErrorStatusBlockLength;
935	} EFI_ACPI_4_0_GENERIC_HARDWARE_ERROR_SOURCE_STRUCTURE;	941	} EFI_ACPI_4_0_GENERIC_HARDWARE_ERROR_SOURCE_STRUCTURE;
936		942
937	///	943	///
938	/// Generic Error Status Definition	944	/// Generic Error Status Definition
939	///	945	///
940	typedef struct {	946	typedef struct {
941	EFI_ACPI_4_0_ERROR_BLOCK_STATUS BlockStatus;	947	EFI_ACPI_4_0_ERROR_BLOCK_STATUS BlockStatus;
942	UINT32 RawDataOffset;	948	UINT32 RawDataOffset;
943	UINT32 RawDataLength;	949	UINT32 RawDataLength;
944	UINT32 DataLength;	950	UINT32 DataLength;
945	UINT32 ErrorSeverity;	951	UINT32 ErrorSeverity;
946	} EFI_ACPI_4_0_GENERIC_ERROR_STATUS_STRUCTURE;	952	} EFI_ACPI_4_0_GENERIC_ERROR_STATUS_STRUCTURE;
947		953
948	///	954	///
949	/// ERST - Error Record Serialization Table	955	/// ERST - Error Record Serialization Table
950	///	956	///
951	typedef struct {	957	typedef struct {
952	EFI_ACPI_DESCRIPTION_HEADER Header;	958	EFI_ACPI_DESCRIPTION_HEADER Header;
953	UINT32 SerializationHeaderSize;	959	UINT32 SerializationHeaderSize;
954	UINT8 Reserved0[4];	960	UINT8 Reserved0[4];
955	UINT32 InstructionEntryCount;	961	UINT32 InstructionEntryCount;
956	} EFI_ACPI_4_0_ERROR_RECORD_SERIALIZATION_TABLE_HEADER;	962	} EFI_ACPI_4_0_ERROR_RECORD_SERIALIZATION_TABLE_HEADER;
957		963
958	///	964	///
959	/// ERST Version (as defined in ACPI 4.0 spec.)	965	/// ERST Version (as defined in ACPI 4.0 spec.)
960	///	966	///
961	#define EFI_ACPI_4_0_ERROR_RECORD_SERIALIZATION_TABLE_REVISION 0x01	967	#define EFI_ACPI_4_0_ERROR_RECORD_SERIALIZATION_TABLE_REVISION 0x01
962		968
963	///	969	///
964	/// ERST Serialization Actions	970	/// ERST Serialization Actions
965	///	971	///
966	#define EFI_ACPI_4_0_ERST_BEGIN_WRITE_OPERATION 0x00	972	#define EFI_ACPI_4_0_ERST_BEGIN_WRITE_OPERATION 0x00
967	#define EFI_ACPI_4_0_ERST_BEGIN_READ_OPERATION 0x01	973	#define EFI_ACPI_4_0_ERST_BEGIN_READ_OPERATION 0x01
968	#define EFI_ACPI_4_0_ERST_BEGIN_CLEAR_OPERATION 0x02	974	#define EFI_ACPI_4_0_ERST_BEGIN_CLEAR_OPERATION 0x02
969	#define EFI_ACPI_4_0_ERST_END_OPERATION 0x03	975	#define EFI_ACPI_4_0_ERST_END_OPERATION 0x03
970	#define EFI_ACPI_4_0_ERST_SET_RECORD_OFFSET 0x04	976	#define EFI_ACPI_4_0_ERST_SET_RECORD_OFFSET 0x04
971	#define EFI_ACPI_4_0_ERST_EXECUTE_OPERATION 0x05	977	#define EFI_ACPI_4_0_ERST_EXECUTE_OPERATION 0x05
972	#define EFI_ACPI_4_0_ERST_CHECK_BUSY_STATUS 0x06	978	#define EFI_ACPI_4_0_ERST_CHECK_BUSY_STATUS 0x06
973	#define EFI_ACPI_4_0_ERST_GET_COMMAND_STATUS 0x07	979	#define EFI_ACPI_4_0_ERST_GET_COMMAND_STATUS 0x07
974	#define EFI_ACPI_4_0_ERST_GET_RECORD_IDENTIFIER 0x08	980	#define EFI_ACPI_4_0_ERST_GET_RECORD_IDENTIFIER 0x08
975	#define EFI_ACPI_4_0_ERST_SET_RECORD_IDENTIFIER 0x09	981	#define EFI_ACPI_4_0_ERST_SET_RECORD_IDENTIFIER 0x09
976	#define EFI_ACPI_4_0_ERST_GET_RECORD_COUNT 0x0A	982	#define EFI_ACPI_4_0_ERST_GET_RECORD_COUNT 0x0A
977	#define EFI_ACPI_4_0_ERST_BEGIN_DUMMY_WRITE_OPERATION 0x0B	983	#define EFI_ACPI_4_0_ERST_BEGIN_DUMMY_WRITE_OPERATION 0x0B
978	#define EFI_ACPI_4_0_ERST_GET_ERROR_LOG_ADDRESS_RANGE 0x0D	984	#define EFI_ACPI_4_0_ERST_GET_ERROR_LOG_ADDRESS_RANGE 0x0D
979	#define EFI_ACPI_4_0_ERST_GET_ERROR_LOG_ADDRESS_RANGE_LENGTH 0x0E	985	#define EFI_ACPI_4_0_ERST_GET_ERROR_LOG_ADDRESS_RANGE_LENGTH 0x0E
980	#define EFI_ACPI_4_0_ERST_GET_ERROR_LOG_ADDRESS_RANGE_ATTRIBUTES 0x0F	986	#define EFI_ACPI_4_0_ERST_GET_ERROR_LOG_ADDRESS_RANGE_ATTRIBUTES 0x0F
981		987
982	///	988	///
983	/// ERST Action Command Status	989	/// ERST Action Command Status
984	///	990	///
985	#define EFI_ACPI_4_0_EINJ_STATUS_SUCCESS 0x00	991	#define EFI_ACPI_4_0_EINJ_STATUS_SUCCESS 0x00
986	#define EFI_ACPI_4_0_EINJ_STATUS_NOT_ENOUGH_SPACE 0x01	992	#define EFI_ACPI_4_0_EINJ_STATUS_NOT_ENOUGH_SPACE 0x01
987	#define EFI_ACPI_4_0_EINJ_STATUS_HARDWARE_NOT_AVAILABLE 0x02	993	#define EFI_ACPI_4_0_EINJ_STATUS_HARDWARE_NOT_AVAILABLE 0x02
988	#define EFI_ACPI_4_0_EINJ_STATUS_FAILED 0x03	994	#define EFI_ACPI_4_0_EINJ_STATUS_FAILED 0x03
989	#define EFI_ACPI_4_0_EINJ_STATUS_RECORD_STORE_EMPTY 0x04	995	#define EFI_ACPI_4_0_EINJ_STATUS_RECORD_STORE_EMPTY 0x04
990	#define EFI_ACPI_4_0_EINJ_STATUS_RECORD_NOT_FOUND 0x05	996	#define EFI_ACPI_4_0_EINJ_STATUS_RECORD_NOT_FOUND 0x05
991		997
992	///	998	///
993	/// ERST Serialization Instructions	999	/// ERST Serialization Instructions
994	///	1000	///
995	#define EFI_ACPI_4_0_ERST_READ_REGISTER 0x00	1001	#define EFI_ACPI_4_0_ERST_READ_REGISTER 0x00
996	#define EFI_ACPI_4_0_ERST_READ_REGISTER_VALUE 0x01	1002	#define EFI_ACPI_4_0_ERST_READ_REGISTER_VALUE 0x01
997	#define EFI_ACPI_4_0_ERST_WRITE_REGISTER 0x02	1003	#define EFI_ACPI_4_0_ERST_WRITE_REGISTER 0x02
998	#define EFI_ACPI_4_0_ERST_WRITE_REGISTER_VALUE 0x03	1004	#define EFI_ACPI_4_0_ERST_WRITE_REGISTER_VALUE 0x03
999	#define EFI_ACPI_4_0_ERST_NOOP 0x04	1005	#define EFI_ACPI_4_0_ERST_NOOP 0x04
1000	#define EFI_ACPI_4_0_ERST_LOAD_VAR1 0x05	1006	#define EFI_ACPI_4_0_ERST_LOAD_VAR1 0x05
1001	#define EFI_ACPI_4_0_ERST_LOAD_VAR2 0x06	1007	#define EFI_ACPI_4_0_ERST_LOAD_VAR2 0x06
1002	#define EFI_ACPI_4_0_ERST_STORE_VAR1 0x07	1008	#define EFI_ACPI_4_0_ERST_STORE_VAR1 0x07
1003	#define EFI_ACPI_4_0_ERST_ADD 0x08	1009	#define EFI_ACPI_4_0_ERST_ADD 0x08
1004	#define EFI_ACPI_4_0_ERST_SUBTRACT 0x09	1010	#define EFI_ACPI_4_0_ERST_SUBTRACT 0x09
1005	#define EFI_ACPI_4_0_ERST_ADD_VALUE 0x0A	1011	#define EFI_ACPI_4_0_ERST_ADD_VALUE 0x0A
1006	#define EFI_ACPI_4_0_ERST_SUBTRACT_VALUE 0x0B	1012	#define EFI_ACPI_4_0_ERST_SUBTRACT_VALUE 0x0B
1007	#define EFI_ACPI_4_0_ERST_STALL 0x0C	1013	#define EFI_ACPI_4_0_ERST_STALL 0x0C
1008	#define EFI_ACPI_4_0_ERST_STALL_WHILE_TRUE 0x0D	1014	#define EFI_ACPI_4_0_ERST_STALL_WHILE_TRUE 0x0D
1009	#define EFI_ACPI_4_0_ERST_SKIP_NEXT_INSTRUCTION_IF_TRUE 0x0E	1015	#define EFI_ACPI_4_0_ERST_SKIP_NEXT_INSTRUCTION_IF_TRUE 0x0E
1010	#define EFI_ACPI_4_0_ERST_GOTO 0x0F	1016	#define EFI_ACPI_4_0_ERST_GOTO 0x0F
1011	#define EFI_ACPI_4_0_ERST_SET_SRC_ADDRESS_BASE 0x10	1017	#define EFI_ACPI_4_0_ERST_SET_SRC_ADDRESS_BASE 0x10
1012	#define EFI_ACPI_4_0_ERST_SET_DST_ADDRESS_BASE 0x11	1018	#define EFI_ACPI_4_0_ERST_SET_DST_ADDRESS_BASE 0x11
1013	#define EFI_ACPI_4_0_ERST_MOVE_DATA 0x12	1019	#define EFI_ACPI_4_0_ERST_MOVE_DATA 0x12
1014		1020
1015	///	1021	///
1016	/// ERST Instruction Flags	1022	/// ERST Instruction Flags
1017	///	1023	///
1018	#define EFI_ACPI_4_0_ERST_PRESERVE_REGISTER 0x01	1024	#define EFI_ACPI_4_0_ERST_PRESERVE_REGISTER 0x01
1019		1025
1020	///	1026	///
1021	/// ERST Serialization Instruction Entry	1027	/// ERST Serialization Instruction Entry
1022	///	1028	///
1023	typedef struct {	1029	typedef struct {
1024	UINT8 SerializationAction;	1030	UINT8 SerializationAction;
1025	UINT8 Instruction;	1031	UINT8 Instruction;
1026	UINT8 Flags;	1032	UINT8 Flags;
1027	UINT8 Reserved0;	1033	UINT8 Reserved0;
1028	EFI_ACPI_4_0_GENERIC_ADDRESS_STRUCTURE RegisterRegion;	1034	EFI_ACPI_4_0_GENERIC_ADDRESS_STRUCTURE RegisterRegion;
1029	UINT64 Value;	1035	UINT64 Value;
1030	UINT64 Mask;	1036	UINT64 Mask;
1031	} EFI_ACPI_4_0_ERST_SERIALIZATION_INSTRUCTION_ENTRY;	1037	} EFI_ACPI_4_0_ERST_SERIALIZATION_INSTRUCTION_ENTRY;
1032		1038
1033	///	1039	///
1034	/// EINJ - Error Injection Table	1040	/// EINJ - Error Injection Table
1035	///	1041	///
1036	typedef struct {	1042	typedef struct {
1037	EFI_ACPI_DESCRIPTION_HEADER Header;	1043	EFI_ACPI_DESCRIPTION_HEADER Header;
1038	UINT32 InjectionHeaderSize;	1044	UINT32 InjectionHeaderSize;
1039	UINT8 InjectionFlags;	1045	UINT8 InjectionFlags;
1040	UINT8 Reserved0[3];	1046	UINT8 Reserved0[3];
1041	UINT32 InjectionEntryCount;	1047	UINT32 InjectionEntryCount;
1042	} EFI_ACPI_4_0_ERROR_INJECTION_TABLE_HEADER;	1048	} EFI_ACPI_4_0_ERROR_INJECTION_TABLE_HEADER;
1043		1049
1044	///	1050	///
1045	/// EINJ Version (as defined in ACPI 4.0 spec.)	1051	/// EINJ Version (as defined in ACPI 4.0 spec.)
1046	///	1052	///
1047	#define EFI_ACPI_4_0_ERROR_INJECTION_TABLE_REVISION 0x01	1053	#define EFI_ACPI_4_0_ERROR_INJECTION_TABLE_REVISION 0x01
1048		1054
1049	///	1055	///
1050	/// EINJ Error Injection Actions	1056	/// EINJ Error Injection Actions
1051	///	1057	///
1052	#define EFI_ACPI_4_0_EINJ_BEGIN_INJECTION_OPERATION 0x00	1058	#define EFI_ACPI_4_0_EINJ_BEGIN_INJECTION_OPERATION 0x00
1053	#define EFI_ACPI_4_0_EINJ_GET_TRIGGER_ERROR_ACTION_TABLE 0x01	1059	#define EFI_ACPI_4_0_EINJ_GET_TRIGGER_ERROR_ACTION_TABLE 0x01
1054	#define EFI_ACPI_4_0_EINJ_SET_ERROR_TYPE 0x02	1060	#define EFI_ACPI_4_0_EINJ_SET_ERROR_TYPE 0x02
1055	#define EFI_ACPI_4_0_EINJ_GET_ERROR_TYPE 0x03	1061	#define EFI_ACPI_4_0_EINJ_GET_ERROR_TYPE 0x03
1056	#define EFI_ACPI_4_0_EINJ_END_OPERATION 0x04	1062	#define EFI_ACPI_4_0_EINJ_END_OPERATION 0x04
1057	#define EFI_ACPI_4_0_EINJ_EXECUTE_OPERATION 0x05	1063	#define EFI_ACPI_4_0_EINJ_EXECUTE_OPERATION 0x05
1058	#define EFI_ACPI_4_0_EINJ_CHECK_BUSY_STATUS 0x06	1064	#define EFI_ACPI_4_0_EINJ_CHECK_BUSY_STATUS 0x06
1059	#define EFI_ACPI_4_0_EINJ_GET_COMMAND_STATUS 0x07	1065	#define EFI_ACPI_4_0_EINJ_GET_COMMAND_STATUS 0x07
1060	#define EFI_ACPI_4_0_EINJ_TRIGGER_ERROR 0xFF	1066	#define EFI_ACPI_4_0_EINJ_TRIGGER_ERROR 0xFF
1061		1067
1062	///	1068	///
1063	/// EINJ Action Command Status	1069	/// EINJ Action Command Status
1064	///	1070	///
1065	#define EFI_ACPI_4_0_EINJ_STATUS_SUCCESS 0x00	1071	#define EFI_ACPI_4_0_EINJ_STATUS_SUCCESS 0x00
1066	#define EFI_ACPI_4_0_EINJ_STATUS_UNKNOWN_FAILURE 0x01	1072	#define EFI_ACPI_4_0_EINJ_STATUS_UNKNOWN_FAILURE 0x01
1067	#define EFI_ACPI_4_0_EINJ_STATUS_INVALID_ACCESS 0x02	1073	#define EFI_ACPI_4_0_EINJ_STATUS_INVALID_ACCESS 0x02
1068		1074
1069	///	1075	///
1070	/// EINJ Error Type Definition	1076	/// EINJ Error Type Definition
1071	///	1077	///
1072	#define EFI_ACPI_4_0_EINJ_ERROR_PROCESSOR_CORRECTABLE (1 << 0)	1078	#define EFI_ACPI_4_0_EINJ_ERROR_PROCESSOR_CORRECTABLE (1 << 0)
1073	#define EFI_ACPI_4_0_EINJ_ERROR_PROCESSOR_UNCORRECTABLE_NONFATAL (1 << 1)	1079	#define EFI_ACPI_4_0_EINJ_ERROR_PROCESSOR_UNCORRECTABLE_NONFATAL (1 << 1)
1074	#define EFI_ACPI_4_0_EINJ_ERROR_PROCESSOR_UNCORRECTABLE_FATAL (1 << 2)	1080	#define EFI_ACPI_4_0_EINJ_ERROR_PROCESSOR_UNCORRECTABLE_FATAL (1 << 2)
1075	#define EFI_ACPI_4_0_EINJ_ERROR_MEMORY_CORRECTABLE (1 << 3)	1081	#define EFI_ACPI_4_0_EINJ_ERROR_MEMORY_CORRECTABLE (1 << 3)
1076	#define EFI_ACPI_4_0_EINJ_ERROR_MEMORY_UNCORRECTABLE_NONFATAL (1 << 4)	1082	#define EFI_ACPI_4_0_EINJ_ERROR_MEMORY_UNCORRECTABLE_NONFATAL (1 << 4)
1077	#define EFI_ACPI_4_0_EINJ_ERROR_MEMORY_UNCORRECTABLE_FATAL (1 << 5)	1083	#define EFI_ACPI_4_0_EINJ_ERROR_MEMORY_UNCORRECTABLE_FATAL (1 << 5)
1078	#define EFI_ACPI_4_0_EINJ_ERROR_PCI_EXPRESS_CORRECTABLE (1 << 6)	1084	#define EFI_ACPI_4_0_EINJ_ERROR_PCI_EXPRESS_CORRECTABLE (1 << 6)
1079	#define EFI_ACPI_4_0_EINJ_ERROR_PCI_EXPRESS_UNCORRECTABLE_NONFATAL (1 << 7)	1085	#define EFI_ACPI_4_0_EINJ_ERROR_PCI_EXPRESS_UNCORRECTABLE_NONFATAL (1 << 7)
1080	#define EFI_ACPI_4_0_EINJ_ERROR_PCI_EXPRESS_UNCORRECTABLE_FATAL (1 << 8)	1086	#define EFI_ACPI_4_0_EINJ_ERROR_PCI_EXPRESS_UNCORRECTABLE_FATAL (1 << 8)
1081	#define EFI_ACPI_4_0_EINJ_ERROR_PLATFORM_CORRECTABLE (1 << 9)	1087	#define EFI_ACPI_4_0_EINJ_ERROR_PLATFORM_CORRECTABLE (1 << 9)
1082	#define EFI_ACPI_4_0_EINJ_ERROR_PLATFORM_UNCORRECTABLE_NONFATAL (1 << 10)	1088	#define EFI_ACPI_4_0_EINJ_ERROR_PLATFORM_UNCORRECTABLE_NONFATAL (1 << 10)
1083	#define EFI_ACPI_4_0_EINJ_ERROR_PLATFORM_UNCORRECTABLE_FATAL (1 << 11)	1089	#define EFI_ACPI_4_0_EINJ_ERROR_PLATFORM_UNCORRECTABLE_FATAL (1 << 11)
1084		1090
1085	///	1091	///
1086	/// EINJ Injection Instructions	1092	/// EINJ Injection Instructions
1087	///	1093	///
1088	#define EFI_ACPI_4_0_EINJ_READ_REGISTER 0x00	1094	#define EFI_ACPI_4_0_EINJ_READ_REGISTER 0x00
1089	#define EFI_ACPI_4_0_EINJ_READ_REGISTER_VALUE 0x01	1095	#define EFI_ACPI_4_0_EINJ_READ_REGISTER_VALUE 0x01
1090	#define EFI_ACPI_4_0_EINJ_WRITE_REGISTER 0x02	1096	#define EFI_ACPI_4_0_EINJ_WRITE_REGISTER 0x02
1091	#define EFI_ACPI_4_0_EINJ_WRITE_REGISTER_VALUE 0x03	1097	#define EFI_ACPI_4_0_EINJ_WRITE_REGISTER_VALUE 0x03
1092	#define EFI_ACPI_4_0_EINJ_NOOP 0x04	1098	#define EFI_ACPI_4_0_EINJ_NOOP 0x04
1093		1099
1094	///	1100	///
1095	/// EINJ Instruction Flags	1101	/// EINJ Instruction Flags
1096	///	1102	///
1097	#define EFI_ACPI_4_0_EINJ_PRESERVE_REGISTER 0x01	1103	#define EFI_ACPI_4_0_EINJ_PRESERVE_REGISTER 0x01
1098		1104
1099	///	1105	///
1100	/// EINJ Injection Instruction Entry	1106	/// EINJ Injection Instruction Entry
1101	///	1107	///
1102	typedef struct {	1108	typedef struct {
1103	UINT8 InjectionAction;	1109	UINT8 InjectionAction;
1104	UINT8 Instruction;	1110	UINT8 Instruction;
1105	UINT8 Flags;	1111	UINT8 Flags;
1106	UINT8 Reserved0;	1112	UINT8 Reserved0;
1107	EFI_ACPI_4_0_GENERIC_ADDRESS_STRUCTURE RegisterRegion;	1113	EFI_ACPI_4_0_GENERIC_ADDRESS_STRUCTURE RegisterRegion;
1108	UINT64 Value;	1114	UINT64 Value;
1109	UINT64 Mask;	1115	UINT64 Mask;
1110	} EFI_ACPI_4_0_EINJ_INJECTION_INSTRUCTION_ENTRY;	1116	} EFI_ACPI_4_0_EINJ_INJECTION_INSTRUCTION_ENTRY;
1111		1117
1112	///	1118	///
1113	/// EINJ Trigger Action Table	1119	/// EINJ Trigger Action Table
1114	///	1120	///
1115	typedef struct {	1121	typedef struct {
1116	UINT32 HeaderSize;	1122	UINT32 HeaderSize;
1117	UINT32 Revision;	1123	UINT32 Revision;
1118	UINT32 TableSize;	1124	UINT32 TableSize;
1119	UINT32 EntryCount;	1125	UINT32 EntryCount;
1120	} EFI_ACPI_4_0_EINJ_TRIGGER_ACTION_TABLE;	1126	} EFI_ACPI_4_0_EINJ_TRIGGER_ACTION_TABLE;
1121		1127
1122	//	1128	//




  ACPI 5.0 definitions from the ACPI Specification Revision 5.0a November 13, 2013.

  Copyright (c) 2014 Hewlett-Packard Development Company, L.P.<BR>
  Copyright (c) 2011 - 2022, Intel Corporation. All rights reserved.<BR>
  Copyright (c) 2020, ARM Ltd. All rights reserved.<BR>
  SPDX-License-Identifier: BSD-2-Clause-Patent
**/

//
// Define for Descriptor
//
#define ACPI_SMALL_FIXED_DMA_DESCRIPTOR_NAME                      0x0A
#define ACPI_LARGE_GPIO_CONNECTION_DESCRIPTOR_NAME                0x0C
#define ACPI_LARGE_GENERIC_SERIAL_BUS_CONNECTION_DESCRIPTOR_NAME  0x0E

#define ACPI_FIXED_DMA_DESCRIPTOR                      0x55
#define ACPI_GPIO_CONNECTION_DESCRIPTOR                0x8C
#define ACPI_GENERIC_SERIAL_BUS_CONNECTION_DESCRIPTOR  0x8E

///
/// _PSD Revision for ACPI 5.0
///
#define EFI_ACPI_5_0_AML_PSD_REVISION  0

///
/// _CPC Revision for ACPI 5.0
///
#define EFI_ACPI_5_0_AML_CPC_REVISION  1

#pragma pack(1)


/// Generic DMA Descriptor.
///
typedef PACKED struct {
  ACPI_SMALL_RESOURCE_HEADER    Header;
  UINT16                        DmaRequestLine;
  UINT16                        DmaChannel;
  UINT8                         DmaTransferWidth;
} EFI_ACPI_FIXED_DMA_DESCRIPTOR;

///

  UINT16                        VendorDataLength;
} EFI_ACPI_GPIO_CONNECTION_DESCRIPTOR;

#define EFI_ACPI_GPIO_CONNECTION_TYPE_INTERRUPT  0x0
#define EFI_ACPI_GPIO_CONNECTION_TYPE_IO         0x1

///
/// Serial Bus Resource Descriptor (Generic)

  UINT16                        TypeSpecificFlags;
  UINT8                         TypeSpecificRevisionId;
  UINT16                        TypeDataLength;
  // Type specific data
} EFI_ACPI_SERIAL_BUS_RESOURCE_DESCRIPTOR;

#define EFI_ACPI_SERIAL_BUS_RESOURCE_TYPE_I2C   0x1

/// ACPI 5.0 Generic Address Space definition
///
typedef struct {
  UINT8     AddressSpaceId;
  UINT8     RegisterBitWidth;
  UINT8     RegisterBitOffset;
  UINT8     AccessSize;
  UINT64    Address;
} EFI_ACPI_5_0_GENERIC_ADDRESS_STRUCTURE;

//
// Generic Address Space Address IDs
//
#define EFI_ACPI_5_0_SYSTEM_MEMORY                   0
#define EFI_ACPI_5_0_SYSTEM_IO                       1
#define EFI_ACPI_5_0_PCI_CONFIGURATION_SPACE         2
#define EFI_ACPI_5_0_EMBEDDED_CONTROLLER             3
#define EFI_ACPI_5_0_SMBUS                           4
#define EFI_ACPI_5_0_PLATFORM_COMMUNICATION_CHANNEL  0x0A
#define EFI_ACPI_5_0_FUNCTIONAL_FIXED_HARDWARE       0x7F


/// Root System Description Pointer Structure
///
typedef struct {
  UINT64    Signature;
  UINT8     Checksum;
  UINT8     OemId[6];
  UINT8     Revision;
  UINT32    RsdtAddress;
  UINT32    Length;
  UINT64    XsdtAddress;
  UINT8     ExtendedChecksum;
  UINT8     Reserved[3];
} EFI_ACPI_5_0_ROOT_SYSTEM_DESCRIPTION_POINTER;

///
/// RSD_PTR Revision (as defined in ACPI 5.0 spec.)
///
#define EFI_ACPI_5_0_ROOT_SYSTEM_DESCRIPTION_POINTER_REVISION  0x02 ///< ACPISpec (Revision 5.0) says current value is 2

///
/// Common table header, this prefaces all ACPI tables, including FACS, but
/// excluding the RSD PTR structure
///
typedef struct {
  UINT32    Signature;
  UINT32    Length;
} EFI_ACPI_5_0_COMMON_HEADER;

//

///
/// RSDT Revision (as defined in ACPI 5.0 spec.)
///
#define EFI_ACPI_5_0_ROOT_SYSTEM_DESCRIPTION_TABLE_REVISION  0x01

//
// Extended System Description Table

///
/// XSDT Revision (as defined in ACPI 5.0 spec.)
///
#define EFI_ACPI_5_0_EXTENDED_SYSTEM_DESCRIPTION_TABLE_REVISION  0x01

///
/// Fixed ACPI Description Table Structure (FADT)
///
typedef struct {
  EFI_ACPI_DESCRIPTION_HEADER               Header;
  UINT32                                    FirmwareCtrl;
  UINT32                                    Dsdt;
  UINT8                                     Reserved0;
  UINT8                                     PreferredPmProfile;
  UINT16                                    SciInt;
  UINT32                                    SmiCmd;
  UINT8                                     AcpiEnable;
  UINT8                                     AcpiDisable;
  UINT8                                     S4BiosReq;
  UINT8                                     PstateCnt;
  UINT32                                    Pm1aEvtBlk;
  UINT32                                    Pm1bEvtBlk;
  UINT32                                    Pm1aCntBlk;
  UINT32                                    Pm1bCntBlk;
  UINT32                                    Pm2CntBlk;
  UINT32                                    PmTmrBlk;
  UINT32                                    Gpe0Blk;
  UINT32                                    Gpe1Blk;
  UINT8                                     Pm1EvtLen;
  UINT8                                     Pm1CntLen;
  UINT8                                     Pm2CntLen;
  UINT8                                     PmTmrLen;
  UINT8                                     Gpe0BlkLen;
  UINT8                                     Gpe1BlkLen;
  UINT8                                     Gpe1Base;
  UINT8                                     CstCnt;
  UINT16                                    PLvl2Lat;
  UINT16                                    PLvl3Lat;
  UINT16                                    FlushSize;
  UINT16                                    FlushStride;
  UINT8                                     DutyOffset;
  UINT8                                     DutyWidth;
  UINT8                                     DayAlrm;
  UINT8                                     MonAlrm;
  UINT8                                     Century;
  UINT16                                    IaPcBootArch;
  UINT8                                     Reserved1;
  UINT32                                    Flags;
  EFI_ACPI_5_0_GENERIC_ADDRESS_STRUCTURE    ResetReg;
  UINT8                                     ResetValue;
  UINT8                                     Reserved2[3];
  UINT64                                    XFirmwareCtrl;
  UINT64                                    XDsdt;
  EFI_ACPI_5_0_GENERIC_ADDRESS_STRUCTURE    XPm1aEvtBlk;
  EFI_ACPI_5_0_GENERIC_ADDRESS_STRUCTURE    XPm1bEvtBlk;
  EFI_ACPI_5_0_GENERIC_ADDRESS_STRUCTURE    XPm1aCntBlk;
  EFI_ACPI_5_0_GENERIC_ADDRESS_STRUCTURE    XPm1bCntBlk;
  EFI_ACPI_5_0_GENERIC_ADDRESS_STRUCTURE    XPm2CntBlk;
  EFI_ACPI_5_0_GENERIC_ADDRESS_STRUCTURE    XPmTmrBlk;
  EFI_ACPI_5_0_GENERIC_ADDRESS_STRUCTURE    XGpe0Blk;
  EFI_ACPI_5_0_GENERIC_ADDRESS_STRUCTURE    XGpe1Blk;
  EFI_ACPI_5_0_GENERIC_ADDRESS_STRUCTURE    SleepControlReg;
  EFI_ACPI_5_0_GENERIC_ADDRESS_STRUCTURE    SleepStatusReg;
} EFI_ACPI_5_0_FIXED_ACPI_DESCRIPTION_TABLE;

///

// Fixed ACPI Description Table Boot Architecture Flags
// All other bits are reserved and must be set to 0.
//
#define EFI_ACPI_5_0_LEGACY_DEVICES        BIT0
#define EFI_ACPI_5_0_8042                  BIT1
#define EFI_ACPI_5_0_VGA_NOT_PRESENT       BIT2
#define EFI_ACPI_5_0_MSI_NOT_SUPPORTED     BIT3
#define EFI_ACPI_5_0_PCIE_ASPM_CONTROLS    BIT4
#define EFI_ACPI_5_0_CMOS_RTC_NOT_PRESENT  BIT5

//
// Fixed ACPI Description Table Fixed Feature Flags
// All other bits are reserved and must be set to 0.
//
#define EFI_ACPI_5_0_WBINVD                                BIT0
#define EFI_ACPI_5_0_WBINVD_FLUSH                          BIT1
#define EFI_ACPI_5_0_PROC_C1                               BIT2
#define EFI_ACPI_5_0_P_LVL2_UP                             BIT3
#define EFI_ACPI_5_0_PWR_BUTTON                            BIT4
#define EFI_ACPI_5_0_SLP_BUTTON                            BIT5
#define EFI_ACPI_5_0_FIX_RTC                               BIT6
#define EFI_ACPI_5_0_RTC_S4                                BIT7
#define EFI_ACPI_5_0_TMR_VAL_EXT                           BIT8
#define EFI_ACPI_5_0_DCK_CAP                               BIT9
#define EFI_ACPI_5_0_RESET_REG_SUP                         BIT10
#define EFI_ACPI_5_0_SEALED_CASE                           BIT11
#define EFI_ACPI_5_0_HEADLESS                              BIT12
#define EFI_ACPI_5_0_CPU_SW_SLP                            BIT13
#define EFI_ACPI_5_0_PCI_EXP_WAK                           BIT14
#define EFI_ACPI_5_0_USE_PLATFORM_CLOCK                    BIT15
#define EFI_ACPI_5_0_S4_RTC_STS_VALID                      BIT16
#define EFI_ACPI_5_0_REMOTE_POWER_ON_CAPABLE               BIT17
#define EFI_ACPI_5_0_FORCE_APIC_CLUSTER_MODEL              BIT18
#define EFI_ACPI_5_0_FORCE_APIC_PHYSICAL_DESTINATION_MODE  BIT19
#define EFI_ACPI_5_0_HW_REDUCED_ACPI                       BIT20
#define EFI_ACPI_5_0_LOW_POWER_S0_IDLE_CAPABLE             BIT21

///
/// Firmware ACPI Control Structure
///
typedef struct {
  UINT32    Signature;
  UINT32    Length;
  UINT32    HardwareSignature;
  UINT32    FirmwareWakingVector;
  UINT32    GlobalLock;
  UINT32    Flags;
  UINT64    XFirmwareWakingVector;
  UINT8     Version;
  UINT8     Reserved0[3];
  UINT32    OspmFlags;
  UINT8     Reserved1[24];
} EFI_ACPI_5_0_FIRMWARE_ACPI_CONTROL_STRUCTURE;

///

/// Firmware Control Structure Feature Flags
/// All other bits are reserved and must be set to 0.
///
#define EFI_ACPI_5_0_S4BIOS_F                BIT0
#define EFI_ACPI_5_0_64BIT_WAKE_SUPPORTED_F  BIT1

///
/// OSPM Enabled Firmware Control Structure Flags
/// All other bits are reserved and must be set to 0.
///
#define EFI_ACPI_5_0_OSPM_64BIT_WAKE_F  BIT0

//
// Differentiated System Description Table,

// no definition needed as they are common description table header, the same with
// EFI_ACPI_DESCRIPTION_HEADER, followed by a definition block.
//
#define EFI_ACPI_5_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_REVISION  0x02
#define EFI_ACPI_5_0_SECONDARY_SYSTEM_DESCRIPTION_TABLE_REVISION       0x02

///
/// Multiple APIC Description Table header definition.  The rest of the table
/// must be defined in a platform specific manner.
///
typedef struct {
  EFI_ACPI_DESCRIPTION_HEADER    Header;
  UINT32                         LocalApicAddress;
  UINT32                         Flags;
} EFI_ACPI_5_0_MULTIPLE_APIC_DESCRIPTION_TABLE_HEADER;

///
/// MADT Revision (as defined in ACPI 5.0 spec.)
///
#define EFI_ACPI_5_0_MULTIPLE_APIC_DESCRIPTION_TABLE_REVISION  0x03

///
/// Multiple APIC Flags
/// All other bits are reserved and must be set to 0.
///
#define EFI_ACPI_5_0_PCAT_COMPAT  BIT0

//
// Multiple APIC Description Table APIC structure types

/// Processor Local APIC Structure Definition
///
typedef struct {
  UINT8     Type;
  UINT8     Length;
  UINT8     AcpiProcessorId;
  UINT8     ApicId;
  UINT32    Flags;
} EFI_ACPI_5_0_PROCESSOR_LOCAL_APIC_STRUCTURE;

///
/// Local APIC Flags.  All other bits are reserved and must be 0.
///
#define EFI_ACPI_5_0_LOCAL_APIC_ENABLED  BIT0

///
/// IO APIC Structure
///
typedef struct {
  UINT8     Type;
  UINT8     Length;
  UINT8     IoApicId;
  UINT8     Reserved;
  UINT32    IoApicAddress;
  UINT32    GlobalSystemInterruptBase;
} EFI_ACPI_5_0_IO_APIC_STRUCTURE;

///
/// Interrupt Source Override Structure
///
typedef struct {
  UINT8     Type;
  UINT8     Length;
  UINT8     Bus;
  UINT8     Source;
  UINT32    GlobalSystemInterrupt;
  UINT16    Flags;
} EFI_ACPI_5_0_INTERRUPT_SOURCE_OVERRIDE_STRUCTURE;

///
/// Platform Interrupt Sources Structure Definition
///
typedef struct {
  UINT8     Type;
  UINT8     Length;
  UINT16    Flags;
  UINT8     InterruptType;
  UINT8     ProcessorId;
  UINT8     ProcessorEid;
  UINT8     IoSapicVector;
  UINT32    GlobalSystemInterrupt;
  UINT32    PlatformInterruptSourceFlags;
  UINT8     CpeiProcessorOverride;
  UINT8     Reserved[31];
} EFI_ACPI_5_0_PLATFORM_INTERRUPT_APIC_STRUCTURE;

//

/// Non-Maskable Interrupt Source Structure
///
typedef struct {
  UINT8     Type;
  UINT8     Length;
  UINT16    Flags;
  UINT32    GlobalSystemInterrupt;
} EFI_ACPI_5_0_NON_MASKABLE_INTERRUPT_SOURCE_STRUCTURE;

///
/// Local APIC NMI Structure
///
typedef struct {
  UINT8     Type;
  UINT8     Length;
  UINT8     AcpiProcessorId;
  UINT16    Flags;
  UINT8     LocalApicLint;
} EFI_ACPI_5_0_LOCAL_APIC_NMI_STRUCTURE;

///
/// Local APIC Address Override Structure
///
typedef struct {
  UINT8     Type;
  UINT8     Length;
  UINT16    Reserved;
  UINT64    LocalApicAddress;
} EFI_ACPI_5_0_LOCAL_APIC_ADDRESS_OVERRIDE_STRUCTURE;

///
/// IO SAPIC Structure
///
typedef struct {
  UINT8     Type;
  UINT8     Length;
  UINT8     IoApicId;
  UINT8     Reserved;
  UINT32    GlobalSystemInterruptBase;
  UINT64    IoSapicAddress;
} EFI_ACPI_5_0_IO_SAPIC_STRUCTURE;

///

/// This struct followed by a null-terminated ASCII string - ACPI Processor UID String
///
typedef struct {
  UINT8     Type;
  UINT8     Length;
  UINT8     AcpiProcessorId;
  UINT8     LocalSapicId;
  UINT8     LocalSapicEid;
  UINT8     Reserved[3];
  UINT32    Flags;
  UINT32    ACPIProcessorUIDValue;
} EFI_ACPI_5_0_PROCESSOR_LOCAL_SAPIC_STRUCTURE;

///
/// Platform Interrupt Sources Structure
///
typedef struct {
  UINT8     Type;
  UINT8     Length;
  UINT16    Flags;
  UINT8     InterruptType;
  UINT8     ProcessorId;
  UINT8     ProcessorEid;
  UINT8     IoSapicVector;
  UINT32    GlobalSystemInterrupt;
  UINT32    PlatformInterruptSourceFlags;
} EFI_ACPI_5_0_PLATFORM_INTERRUPT_SOURCES_STRUCTURE;

///
/// Platform Interrupt Source Flags.
/// All other bits are reserved and must be set to 0.
///
#define EFI_ACPI_5_0_CPEI_PROCESSOR_OVERRIDE  BIT0

///
/// Processor Local x2APIC Structure Definition
///
typedef struct {
  UINT8     Type;
  UINT8     Length;
  UINT8     Reserved[2];
  UINT32    X2ApicId;
  UINT32    Flags;
  UINT32    AcpiProcessorUid;
} EFI_ACPI_5_0_PROCESSOR_LOCAL_X2APIC_STRUCTURE;

///
/// Local x2APIC NMI Structure
///
typedef struct {
  UINT8     Type;
  UINT8     Length;
  UINT16    Flags;
  UINT32    AcpiProcessorUid;
  UINT8     LocalX2ApicLint;
  UINT8     Reserved[3];
} EFI_ACPI_5_0_LOCAL_X2APIC_NMI_STRUCTURE;

///
/// GIC Structure
///
typedef struct {
  UINT8     Type;
  UINT8     Length;
  UINT16    Reserved;
  UINT32    GicId;
  UINT32    AcpiProcessorUid;
  UINT32    Flags;
  UINT32    ParkingProtocolVersion;
  UINT32    PerformanceInterruptGsiv;
  UINT64    ParkedAddress;
  UINT64    PhysicalBaseAddress;
} EFI_ACPI_5_0_GIC_STRUCTURE;

///
/// GIC Flags.  All other bits are reserved and must be 0.
///
#define EFI_ACPI_5_0_GIC_ENABLED                  BIT0
#define EFI_ACPI_5_0_PERFORMANCE_INTERRUPT_MODEL  BIT1

///
/// GIC Distributor Structure
///
typedef struct {
  UINT8     Type;
  UINT8     Length;
  UINT16    Reserved1;
  UINT32    GicId;
  UINT64    PhysicalBaseAddress;
  UINT32    SystemVectorBase;
  UINT32    Reserved2;
} EFI_ACPI_5_0_GIC_DISTRIBUTOR_STRUCTURE;

///
/// Smart Battery Description Table (SBST)
///
typedef struct {
  EFI_ACPI_DESCRIPTION_HEADER    Header;
  UINT32                         WarningEnergyLevel;
  UINT32                         LowEnergyLevel;
  UINT32                         CriticalEnergyLevel;
} EFI_ACPI_5_0_SMART_BATTERY_DESCRIPTION_TABLE;

///
/// SBST Version (as defined in ACPI 5.0 spec.)
///
#define EFI_ACPI_5_0_SMART_BATTERY_DESCRIPTION_TABLE_REVISION  0x01

///
/// Embedded Controller Boot Resources Table (ECDT)

/// a fully qualified reference to the name space object.
///
typedef struct {
  EFI_ACPI_DESCRIPTION_HEADER               Header;
  EFI_ACPI_5_0_GENERIC_ADDRESS_STRUCTURE    EcControl;
  EFI_ACPI_5_0_GENERIC_ADDRESS_STRUCTURE    EcData;
  UINT32                                    Uid;
  UINT8                                     GpeBit;
} EFI_ACPI_5_0_EMBEDDED_CONTROLLER_BOOT_RESOURCES_TABLE;

///

/// must be defined in a platform specific manner.
///
typedef struct {
  EFI_ACPI_DESCRIPTION_HEADER    Header;
  UINT32                         Reserved1; ///< Must be set to 1
  UINT64                         Reserved2;
} EFI_ACPI_5_0_SYSTEM_RESOURCE_AFFINITY_TABLE_HEADER;

///

/// Processor Local APIC/SAPIC Affinity Structure Definition
///
typedef struct {
  UINT8     Type;
  UINT8     Length;
  UINT8     ProximityDomain7To0;
  UINT8     ApicId;
  UINT32    Flags;
  UINT8     LocalSapicEid;
  UINT8     ProximityDomain31To8[3];
  UINT32    ClockDomain;
} EFI_ACPI_5_0_PROCESSOR_LOCAL_APIC_SAPIC_AFFINITY_STRUCTURE;

///
/// Local APIC/SAPIC Flags.  All other bits are reserved and must be 0.
///
#define EFI_ACPI_5_0_PROCESSOR_LOCAL_APIC_SAPIC_ENABLED  (1 << 0)

///
/// Memory Affinity Structure Definition
///
typedef struct {
  UINT8     Type;
  UINT8     Length;
  UINT32    ProximityDomain;
  UINT16    Reserved1;
  UINT32    AddressBaseLow;
  UINT32    AddressBaseHigh;
  UINT32    LengthLow;
  UINT32    LengthHigh;
  UINT32    Reserved2;
  UINT32    Flags;
  UINT64    Reserved3;
} EFI_ACPI_5_0_MEMORY_AFFINITY_STRUCTURE;

//
// Memory Flags.  All other bits are reserved and must be 0.
//
#define EFI_ACPI_5_0_MEMORY_ENABLED        (1 << 0)
#define EFI_ACPI_5_0_MEMORY_HOT_PLUGGABLE  (1 << 1)
#define EFI_ACPI_5_0_MEMORY_NONVOLATILE    (1 << 2)

///
/// Processor Local x2APIC Affinity Structure Definition
///
typedef struct {
  UINT8     Type;
  UINT8     Length;
  UINT8     Reserved1[2];
  UINT32    ProximityDomain;
  UINT32    X2ApicId;
  UINT32    Flags;
  UINT32    ClockDomain;
  UINT8     Reserved2[4];
} EFI_ACPI_5_0_PROCESSOR_LOCAL_X2APIC_AFFINITY_STRUCTURE;

///

/// The rest of the table is a matrix.
///
typedef struct {
  EFI_ACPI_DESCRIPTION_HEADER    Header;
  UINT64                         NumberOfSystemLocalities;
} EFI_ACPI_5_0_SYSTEM_LOCALITY_DISTANCE_INFORMATION_TABLE_HEADER;

///

/// Corrected Platform Error Polling Table (CPEP)
///
typedef struct {
  EFI_ACPI_DESCRIPTION_HEADER    Header;
  UINT8                          Reserved[8];
} EFI_ACPI_5_0_CORRECTED_PLATFORM_ERROR_POLLING_TABLE_HEADER;

///
/// CPEP Version (as defined in ACPI 5.0 spec.)
///
#define EFI_ACPI_5_0_CORRECTED_PLATFORM_ERROR_POLLING_TABLE_REVISION  0x01

//
// CPEP processor structure types.

/// Corrected Platform Error Polling Processor Structure Definition
///
typedef struct {
  UINT8     Type;
  UINT8     Length;
  UINT8     ProcessorId;
  UINT8     ProcessorEid;
  UINT32    PollingInterval;
} EFI_ACPI_5_0_CPEP_PROCESSOR_APIC_SAPIC_STRUCTURE;

///
/// Maximum System Characteristics Table (MSCT)
///
typedef struct {
  EFI_ACPI_DESCRIPTION_HEADER    Header;
  UINT32                         OffsetProxDomInfo;
  UINT32                         MaximumNumberOfProximityDomains;
  UINT32                         MaximumNumberOfClockDomains;
  UINT64                         MaximumPhysicalAddress;
} EFI_ACPI_5_0_MAXIMUM_SYSTEM_CHARACTERISTICS_TABLE_HEADER;

///
/// MSCT Version (as defined in ACPI 5.0 spec.)
///
#define EFI_ACPI_5_0_MAXIMUM_SYSTEM_CHARACTERISTICS_TABLE_REVISION  0x01

///
/// Maximum Proximity Domain Information Structure Definition
///
typedef struct {
  UINT8     Revision;
  UINT8     Length;
  UINT32    ProximityDomainRangeLow;
  UINT32    ProximityDomainRangeHigh;
  UINT32    MaximumProcessorCapacity;
  UINT64    MaximumMemoryCapacity;
} EFI_ACPI_5_0_MAXIMUM_PROXIMITY_DOMAIN_INFORMATION_STRUCTURE;

///
/// ACPI RAS Feature Table definition.
///
typedef struct {
  EFI_ACPI_DESCRIPTION_HEADER    Header;
  UINT8                          PlatformCommunicationChannelIdentifier[12];
} EFI_ACPI_5_0_RAS_FEATURE_TABLE;

///
/// RASF Version (as defined in ACPI 5.0 spec.)
///
#define EFI_ACPI_5_0_RAS_FEATURE_TABLE_REVISION  0x01

///
/// ACPI RASF Platform Communication Channel Shared Memory Region definition.
///
typedef struct {
  UINT32    Signature;
  UINT16    Command;
  UINT16    Status;
  UINT16    Version;
  UINT8     RASCapabilities[16];
  UINT8     SetRASCapabilities[16];
  UINT16    NumberOfRASFParameterBlocks;
  UINT32    SetRASCapabilitiesStatus;
} EFI_ACPI_5_0_RASF_PLATFORM_COMMUNICATION_CHANNEL_SHARED_MEMORY_REGION;

///

/// ACPI RASF Parameter Block structure for PATROL_SCRUB
///
typedef struct {
  UINT16    Type;
  UINT16    Version;
  UINT16    Length;
  UINT16    PatrolScrubCommand;
  UINT64    RequestedAddressRange[2];
  UINT64    ActualAddressRange[2];
  UINT16    Flags;
  UINT8     RequestedSpeed;
} EFI_ACPI_5_0_RASF_PATROL_SCRUB_PLATFORM_BLOCK_STRUCTURE;

///
/// ACPI RASF Patrol Scrub command
///
#define EFI_ACPI_5_0_RASF_PATROL_SCRUB_COMMAND_GET_PATROL_PARAMETERS  0x01
#define EFI_ACPI_5_0_RASF_PATROL_SCRUB_COMMAND_START_PATROL_SCRUBBER  0x02
#define EFI_ACPI_5_0_RASF_PATROL_SCRUB_COMMAND_STOP_PATROL_SCRUBBER   0x03

///
/// Memory Power State Table definition.
///
typedef struct {
  EFI_ACPI_DESCRIPTION_HEADER    Header;
  UINT8                          PlatformCommunicationChannelIdentifier;
  UINT8                          Reserved[3];
  // Memory Power Node Structure
  // Memory Power State Characteristics
} EFI_ACPI_5_0_MEMORY_POWER_STATUS_TABLE;

///
/// MPST Version (as defined in ACPI 5.0 spec.)
///
#define EFI_ACPI_5_0_MEMORY_POWER_STATE_TABLE_REVISION  0x01

///
/// MPST Platform Communication Channel Shared Memory Region definition.
///
typedef struct {
  UINT32    Signature;
  UINT16    Command;
  UINT16    Status;
  UINT32    MemoryPowerCommandRegister;
  UINT32    MemoryPowerStatusRegister;
  UINT32    PowerStateId;
  UINT32    MemoryPowerNodeId;
  UINT64    MemoryEnergyConsumed;
  UINT64    ExpectedAveragePowerComsuned;
} EFI_ACPI_5_0_MPST_PLATFORM_COMMUNICATION_CHANNEL_SHARED_MEMORY_REGION;

///

///
/// ACPI MPST Memory Power command
///
#define EFI_ACPI_5_0_MPST_MEMORY_POWER_COMMAND_GET_MEMORY_POWER_STATE      0x01
#define EFI_ACPI_5_0_MPST_MEMORY_POWER_COMMAND_SET_MEMORY_POWER_STATE      0x02
#define EFI_ACPI_5_0_MPST_MEMORY_POWER_COMMAND_GET_AVERAGE_POWER_CONSUMED  0x03
#define EFI_ACPI_5_0_MPST_MEMORY_POWER_COMMAND_GET_MEMORY_ENERGY_CONSUMED  0x04

///
/// MPST Memory Power Node Table
///
typedef struct {
  UINT8    PowerStateValue;
  UINT8    PowerStateInformationIndex;
} EFI_ACPI_5_0_MPST_MEMORY_POWER_STATE;

typedef struct {
  UINT8     Flag;
  UINT8     Reserved;
  UINT16    MemoryPowerNodeId;
  UINT32    Length;
  UINT64    AddressBase;
  UINT64    AddressLength;
  UINT32    NumberOfPowerStates;
  UINT32    NumberOfPhysicalComponents;
  // EFI_ACPI_5_0_MPST_MEMORY_POWER_STATE              MemoryPowerState[NumberOfPowerStates];
  // UINT16                                            PhysicalComponentIdentifier[NumberOfPhysicalComponents];
} EFI_ACPI_5_0_MPST_MEMORY_POWER_STRUCTURE;

#define EFI_ACPI_5_0_MPST_MEMORY_POWER_STRUCTURE_FLAG_ENABLE         0x01
#define EFI_ACPI_5_0_MPST_MEMORY_POWER_STRUCTURE_FLAG_POWER_MANAGED  0x02
#define EFI_ACPI_5_0_MPST_MEMORY_POWER_STRUCTURE_FLAG_HOT_PLUGGABLE  0x04

typedef struct {
  UINT16    MemoryPowerNodeCount;
  UINT8     Reserved[2];
} EFI_ACPI_5_0_MPST_MEMORY_POWER_NODE_TABLE;

///
/// MPST Memory Power State Characteristics Table
///
typedef struct {
  UINT8     PowerStateStructureID;
  UINT8     Flag;
  UINT16    Reserved;
  UINT32    AveragePowerConsumedInMPS0;
  UINT32    RelativePowerSavingToMPS0;
  UINT64    ExitLatencyToMPS0;
} EFI_ACPI_5_0_MPST_MEMORY_POWER_STATE_CHARACTERISTICS_STRUCTURE;

#define EFI_ACPI_5_0_MPST_MEMORY_POWER_STATE_CHARACTERISTICS_STRUCTURE_FLAG_MEMORY_CONTENT_PRESERVED             0x01
#define EFI_ACPI_5_0_MPST_MEMORY_POWER_STATE_CHARACTERISTICS_STRUCTURE_FLAG_AUTONOMOUS_MEMORY_POWER_STATE_ENTRY  0x02
#define EFI_ACPI_5_0_MPST_MEMORY_POWER_STATE_CHARACTERISTICS_STRUCTURE_FLAG_AUTONOMOUS_MEMORY_POWER_STATE_EXIT   0x04

typedef struct {
  UINT16    MemoryPowerStateCharacteristicsCount;
  UINT8     Reserved[2];
} EFI_ACPI_5_0_MPST_MEMORY_POWER_STATE_CHARACTERISTICS_TABLE;

///
/// Memory Topology Table definition.
///
typedef struct {
  EFI_ACPI_DESCRIPTION_HEADER    Header;
  UINT32                         Reserved;
} EFI_ACPI_5_0_MEMORY_TOPOLOGY_TABLE;

///
/// PMTT Version (as defined in ACPI 5.0 spec.)
///
#define EFI_ACPI_5_0_MEMORY_TOPOLOGY_TABLE_REVISION  0x01

///
/// Common Memory Aggregator Device Structure.
///
typedef struct {
  UINT8     Type;
  UINT8     Reserved;
  UINT16    Length;
  UINT16    Flags;
  UINT16    Reserved1;
} EFI_ACPI_5_0_PMMT_COMMON_MEMORY_AGGREGATOR_DEVICE_STRUCTURE;

///
/// Memory Aggregator Device Type
///
#define EFI_ACPI_5_0_PMMT_MEMORY_AGGREGATOR_DEVICE_TYPE_SOCKET             0x0
#define EFI_ACPI_5_0_PMMT_MEMORY_AGGREGATOR_DEVICE_TYPE_MEMORY_CONTROLLER  0x1
#define EFI_ACPI_5_0_PMMT_MEMORY_AGGREGATOR_DEVICE_TYPE_DIMM               0x2

///
/// Socket Memory Aggregator Device Structure.
///
typedef struct {
  EFI_ACPI_5_0_PMMT_COMMON_MEMORY_AGGREGATOR_DEVICE_STRUCTURE    Header;
  UINT16                                                         SocketIdentifier;
  UINT16                                                         Reserved;
  // EFI_ACPI_5_0_PMMT_MEMORY_CONTROLLER_MEMORY_AGGREGATOR_DEVICE_STRUCTURE  MemoryController[];
} EFI_ACPI_5_0_PMMT_SOCKET_MEMORY_AGGREGATOR_DEVICE_STRUCTURE;

///
/// MemoryController Memory Aggregator Device Structure.
///
typedef struct {
  EFI_ACPI_5_0_PMMT_COMMON_MEMORY_AGGREGATOR_DEVICE_STRUCTURE    Header;
  UINT32                                                         ReadLatency;
  UINT32                                                         WriteLatency;
  UINT32                                                         ReadBandwidth;
  UINT32                                                         WriteBandwidth;
  UINT16                                                         OptimalAccessUnit;
  UINT16                                                         OptimalAccessAlignment;
  UINT16                                                         Reserved;
  UINT16                                                         NumberOfProximityDomains;
  // UINT32                                                       ProximityDomain[NumberOfProximityDomains];
  // EFI_ACPI_5_0_PMMT_DIMM_MEMORY_AGGREGATOR_DEVICE_STRUCTURE    PhysicalComponent[];
} EFI_ACPI_5_0_PMMT_MEMORY_CONTROLLER_MEMORY_AGGREGATOR_DEVICE_STRUCTURE;

///
/// DIMM Memory Aggregator Device Structure.
///
typedef struct {
  EFI_ACPI_5_0_PMMT_COMMON_MEMORY_AGGREGATOR_DEVICE_STRUCTURE    Header;
  UINT16                                                         PhysicalComponentIdentifier;
  UINT16                                                         Reserved;
  UINT32                                                         SizeOfDimm;
  UINT32                                                         SmbiosHandle;
} EFI_ACPI_5_0_PMMT_DIMM_MEMORY_AGGREGATOR_DEVICE_STRUCTURE;

///
/// Boot Graphics Resource Table definition.
///
typedef struct {
  EFI_ACPI_DESCRIPTION_HEADER    Header;
  ///
  /// 2-bytes (16 bit) version ID. This value must be 1.
  ///
  UINT16                         Version;
  ///
  /// 1-byte status field indicating current status about the table.
  ///     Bits[7:1] = Reserved (must be zero)
  ///     Bit [0] = Valid. A one indicates the boot image graphic is valid.
  ///
  UINT8                          Status;
  ///
  /// 1-byte enumerated type field indicating format of the image.
  ///     0 = Bitmap
  ///     1 - 255  Reserved (for future use)
  ///
  UINT8                          ImageType;
  ///
  /// 8-byte (64 bit) physical address pointing to the firmware's in-memory copy
  /// of the image bitmap.
  ///
  UINT64                         ImageAddress;
  ///
  /// A 4-byte (32-bit) unsigned long describing the display X-offset of the boot image.
  /// (X, Y) display offset of the top left corner of the boot image.
  /// The top left corner of the display is at offset (0, 0).
  ///
  UINT32                         ImageOffsetX;
  ///
  /// A 4-byte (32-bit) unsigned long describing the display Y-offset of the boot image.
  /// (X, Y) display offset of the top left corner of the boot image.
  /// The top left corner of the display is at offset (0, 0).
  ///
  UINT32                         ImageOffsetY;
} EFI_ACPI_5_0_BOOT_GRAPHICS_RESOURCE_TABLE;

///
/// BGRT Revision
///
#define EFI_ACPI_5_0_BOOT_GRAPHICS_RESOURCE_TABLE_REVISION  1

///
/// BGRT Version
///
#define EFI_ACPI_5_0_BGRT_VERSION  0x01

///
/// BGRT Status
///
#define EFI_ACPI_5_0_BGRT_STATUS_NOT_DISPLAYED  0x00
#define EFI_ACPI_5_0_BGRT_STATUS_DISPLAYED      0x01
#define EFI_ACPI_5_0_BGRT_STATUS_INVALID        EFI_ACPI_5_0_BGRT_STATUS_NOT_DISPLAYED
#define EFI_ACPI_5_0_BGRT_STATUS_VALID          EFI_ACPI_5_0_BGRT_STATUS_DISPLAYED

///
/// BGRT Image Type

///
/// FPDT Version (as defined in ACPI 5.0 spec.)
///
#define EFI_ACPI_5_0_FIRMWARE_PERFORMANCE_DATA_TABLE_REVISION  0x01

///
/// FPDT Performance Record Types
///
#define EFI_ACPI_5_0_FPDT_RECORD_TYPE_FIRMWARE_BASIC_BOOT_POINTER   0x0000
#define EFI_ACPI_5_0_FPDT_RECORD_TYPE_S3_PERFORMANCE_TABLE_POINTER  0x0001

///
/// FPDT Performance Record Revision
///
#define EFI_ACPI_5_0_FPDT_RECORD_REVISION_FIRMWARE_BASIC_BOOT_POINTER   0x01
#define EFI_ACPI_5_0_FPDT_RECORD_REVISION_S3_PERFORMANCE_TABLE_POINTER  0x01

///
/// FPDT Runtime Performance Record Types
///
#define EFI_ACPI_5_0_FPDT_RUNTIME_RECORD_TYPE_S3_RESUME            0x0000
#define EFI_ACPI_5_0_FPDT_RUNTIME_RECORD_TYPE_S3_SUSPEND           0x0001
#define EFI_ACPI_5_0_FPDT_RUNTIME_RECORD_TYPE_FIRMWARE_BASIC_BOOT  0x0002

///
/// FPDT Runtime Performance Record Revision

/// FPDT Performance Record header
///
typedef struct {
  UINT16    Type;
  UINT8     Length;
  UINT8     Revision;
} EFI_ACPI_5_0_FPDT_PERFORMANCE_RECORD_HEADER;

///
/// FPDT Performance Table header
///
typedef struct {
  UINT32    Signature;
  UINT32    Length;
} EFI_ACPI_5_0_FPDT_PERFORMANCE_TABLE_HEADER;

///
/// FPDT Firmware Basic Boot Performance Pointer Record Structure
///
typedef struct {
  EFI_ACPI_5_0_FPDT_PERFORMANCE_RECORD_HEADER    Header;
  UINT32                                         Reserved;
  ///
  /// 64-bit processor-relative physical address of the Basic Boot Performance Table.
  ///
  UINT64                                         BootPerformanceTablePointer;
} EFI_ACPI_5_0_FPDT_BOOT_PERFORMANCE_TABLE_POINTER_RECORD;

///
/// FPDT S3 Performance Table Pointer Record Structure
///
typedef struct {
  EFI_ACPI_5_0_FPDT_PERFORMANCE_RECORD_HEADER    Header;
  UINT32                                         Reserved;
  ///
  /// 64-bit processor-relative physical address of the S3 Performance Table.
  ///
  UINT64                                         S3PerformanceTablePointer;
} EFI_ACPI_5_0_FPDT_S3_PERFORMANCE_TABLE_POINTER_RECORD;

///
/// FPDT Firmware Basic Boot Performance Record Structure
///
typedef struct {
  EFI_ACPI_5_0_FPDT_PERFORMANCE_RECORD_HEADER    Header;
  UINT32                                         Reserved;
  ///
  /// Timer value logged at the beginning of firmware image execution.
  /// This may not always be zero or near zero.
  ///
  UINT64                                         ResetEnd;
  ///
  /// Timer value logged just prior to loading the OS boot loader into memory.
  /// For non-UEFI compatible boots, this field must be zero.
  ///
  UINT64                                         OsLoaderLoadImageStart;
  ///
  /// Timer value logged just prior to launching the previously loaded OS boot loader image.
  /// For non-UEFI compatible boots, the timer value logged will be just prior
  /// to the INT 19h handler invocation.
  ///
  UINT64                                         OsLoaderStartImageStart;
  ///
  /// Timer value logged at the point when the OS loader calls the
  /// ExitBootServices function for UEFI compatible firmware.
  /// For non-UEFI compatible boots, this field must be zero.
  ///
  UINT64                                         ExitBootServicesEntry;
  ///
  /// Timer value logged at the point just prior to when the OS loader gaining
  /// control back from calls the ExitBootServices function for UEFI compatible firmware.
  /// For non-UEFI compatible boots, this field must be zero.
  ///
  UINT64                                         ExitBootServicesExit;
} EFI_ACPI_5_0_FPDT_FIRMWARE_BASIC_BOOT_RECORD;

///

// FPDT Firmware Basic Boot Performance Table
//
typedef struct {
  EFI_ACPI_5_0_FPDT_PERFORMANCE_TABLE_HEADER    Header;
  //
  // one or more Performance Records.
  //

// FPDT Firmware S3 Boot Performance Table
//
typedef struct {
  EFI_ACPI_5_0_FPDT_PERFORMANCE_TABLE_HEADER    Header;
  //
  // one or more Performance Records.
  //

/// FPDT Basic S3 Resume Performance Record
///
typedef struct {
  EFI_ACPI_5_0_FPDT_PERFORMANCE_RECORD_HEADER    Header;
  ///
  /// A count of the number of S3 resume cycles since the last full boot sequence.
  ///
  UINT32                                         ResumeCount;
  ///
  /// Timer recorded at the end of BIOS S3 resume, just prior to handoff to the
  /// OS waking vector. Only the most recent resume cycle's time is retained.
  ///
  UINT64                                         FullResume;
  ///
  /// Average timer value of all resume cycles logged since the last full boot
  /// sequence, including the most recent resume.  Note that the entire log of
  /// timer values does not need to be retained in order to calculate this average.
  ///
  UINT64                                         AverageResume;
} EFI_ACPI_5_0_FPDT_S3_RESUME_RECORD;

///
/// FPDT Basic S3 Suspend Performance Record
///
typedef struct {
  EFI_ACPI_5_0_FPDT_PERFORMANCE_RECORD_HEADER    Header;
  ///
  /// Timer value recorded at the OS write to SLP_TYP upon entry to S3.
  /// Only the most recent suspend cycle's timer value is retained.
  ///
  UINT64                                         SuspendStart;
  ///
  /// Timer value recorded at the final firmware write to SLP_TYP (or other
  /// mechanism) used to trigger hardware entry to S3.
  /// Only the most recent suspend cycle's timer value is retained.
  ///
  UINT64                                         SuspendEnd;
} EFI_ACPI_5_0_FPDT_S3_SUSPEND_RECORD;

///
/// Firmware Performance Record Table definition.
///
typedef struct {
  EFI_ACPI_DESCRIPTION_HEADER    Header;
} EFI_ACPI_5_0_FIRMWARE_PERFORMANCE_RECORD_TABLE;

///
/// Generic Timer Description Table definition.
///
typedef struct {
  EFI_ACPI_DESCRIPTION_HEADER    Header;
  UINT64                         PhysicalAddress;
  UINT32                         GlobalFlags;
  UINT32                         SecurePL1TimerGSIV;
  UINT32                         SecurePL1TimerFlags;
  UINT32                         NonSecurePL1TimerGSIV;
  UINT32                         NonSecurePL1TimerFlags;
  UINT32                         VirtualTimerGSIV;
  UINT32                         VirtualTimerFlags;
  UINT32                         NonSecurePL2TimerGSIV;
  UINT32                         NonSecurePL2TimerFlags;
} EFI_ACPI_5_0_GENERIC_TIMER_DESCRIPTION_TABLE;

///
/// GTDT Version (as defined in ACPI 5.0 spec.)
///
#define EFI_ACPI_5_0_GENERIC_TIMER_DESCRIPTION_TABLE_REVISION  0x01

///
/// Global Flags.  All other bits are reserved and must be 0.
///
#define EFI_ACPI_5_0_GTDT_GLOBAL_FLAG_MEMORY_MAPPED_BLOCK_PRESENT  BIT0
#define EFI_ACPI_5_0_GTDT_GLOBAL_FLAG_INTERRUPT_MODE               BIT1

///
/// Timer Flags.  All other bits are reserved and must be 0.
///
#define EFI_ACPI_5_0_GTDT_TIMER_FLAG_TIMER_INTERRUPT_MODE      BIT0
#define EFI_ACPI_5_0_GTDT_TIMER_FLAG_TIMER_INTERRUPT_POLARITY  BIT1

///
/// Boot Error Record Table (BERT)
///
typedef struct {
  EFI_ACPI_DESCRIPTION_HEADER    Header;
  UINT32                         BootErrorRegionLength;
  UINT64                         BootErrorRegion;
} EFI_ACPI_5_0_BOOT_ERROR_RECORD_TABLE_HEADER;

///
/// BERT Version (as defined in ACPI 5.0 spec.)
///
#define EFI_ACPI_5_0_BOOT_ERROR_RECORD_TABLE_REVISION  0x01

///
/// Boot Error Region Block Status Definition
///
typedef struct {
  UINT32    UncorrectableErrorValid     : 1;
  UINT32    CorrectableErrorValid       : 1;
  UINT32    MultipleUncorrectableErrors : 1;
  UINT32    MultipleCorrectableErrors   : 1;
  UINT32    ErrorDataEntryCount         : 10;
  UINT32    Reserved                    : 18;
} EFI_ACPI_5_0_ERROR_BLOCK_STATUS;

///
/// Boot Error Region Definition
///
typedef struct {
  EFI_ACPI_5_0_ERROR_BLOCK_STATUS    BlockStatus;
  UINT32                             RawDataOffset;
  UINT32                             RawDataLength;
  UINT32                             DataLength;
  UINT32                             ErrorSeverity;
} EFI_ACPI_5_0_BOOT_ERROR_REGION_STRUCTURE;

//
// Boot Error Severity types
//
#define EFI_ACPI_5_0_ERROR_SEVERITY_CORRECTABLE  0x00
#define EFI_ACPI_5_0_ERROR_SEVERITY_RECOVERABLE  0x00
#define EFI_ACPI_5_0_ERROR_SEVERITY_FATAL        0x01
#define EFI_ACPI_5_0_ERROR_SEVERITY_CORRECTED    0x02
#define EFI_ACPI_5_0_ERROR_SEVERITY_NONE         0x03

/// Generic Error Data Entry Definition
///
typedef struct {
  UINT8     SectionType[16];
  UINT32    ErrorSeverity;
  UINT16    Revision;
  UINT8     ValidationBits;
  UINT8     Flags;
  UINT32    ErrorDataLength;
  UINT8     FruId[16];
  UINT8     FruText[20];
} EFI_ACPI_5_0_GENERIC_ERROR_DATA_ENTRY_STRUCTURE;

///

/// HEST - Hardware Error Source Table
///
typedef struct {
  EFI_ACPI_DESCRIPTION_HEADER    Header;
  UINT32                         ErrorSourceCount;
} EFI_ACPI_5_0_HARDWARE_ERROR_SOURCE_TABLE_HEADER;

///
/// HEST Version (as defined in ACPI 5.0 spec.)
///
#define EFI_ACPI_5_0_HARDWARE_ERROR_SOURCE_TABLE_REVISION  0x01

//
// Error Source structure types.

//
// Error Source structure flags.
//
#define EFI_ACPI_5_0_ERROR_SOURCE_FLAG_FIRMWARE_FIRST  (1 << 0)
#define EFI_ACPI_5_0_ERROR_SOURCE_FLAG_GLOBAL          (1 << 1)

///
/// IA-32 Architecture Machine Check Exception Structure Definition
///
typedef struct {
  UINT16    Type;
  UINT16    SourceId;
  UINT8     Reserved0[2];
  UINT8     Flags;
  UINT8     Enabled;
  UINT32    NumberOfRecordsToPreAllocate;
  UINT32    MaxSectionsPerRecord;
  UINT64    GlobalCapabilityInitData;
  UINT64    GlobalControlInitData;
  UINT8     NumberOfHardwareBanks;
  UINT8     Reserved1[7];
} EFI_ACPI_5_0_IA32_ARCHITECTURE_MACHINE_CHECK_EXCEPTION_STRUCTURE;

///
/// IA-32 Architecture Machine Check Bank Structure Definition
///
typedef struct {
  UINT8     BankNumber;
  UINT8     ClearStatusOnInitialization;
  UINT8     StatusDataFormat;
  UINT8     Reserved0;
  UINT32    ControlRegisterMsrAddress;
  UINT64    ControlInitData;
  UINT32    StatusRegisterMsrAddress;
  UINT32    AddressRegisterMsrAddress;
  UINT32    MiscRegisterMsrAddress;
} EFI_ACPI_5_0_IA32_ARCHITECTURE_MACHINE_CHECK_ERROR_BANK_STRUCTURE;

///
/// IA-32 Architecture Machine Check Bank Structure MCA data format
///
#define EFI_ACPI_5_0_IA32_ARCHITECTURE_MACHINE_CHECK_ERROR_DATA_FORMAT_IA32     0x00
#define EFI_ACPI_5_0_IA32_ARCHITECTURE_MACHINE_CHECK_ERROR_DATA_FORMAT_INTEL64  0x01
#define EFI_ACPI_5_0_IA32_ARCHITECTURE_MACHINE_CHECK_ERROR_DATA_FORMAT_AMD64    0x02

//
// Hardware Error Notification types. All other values are reserved
//
#define EFI_ACPI_5_0_HARDWARE_ERROR_NOTIFICATION_POLLED              0x00
#define EFI_ACPI_5_0_HARDWARE_ERROR_NOTIFICATION_EXTERNAL_INTERRUPT  0x01
#define EFI_ACPI_5_0_HARDWARE_ERROR_NOTIFICATION_LOCAL_INTERRUPT     0x02
#define EFI_ACPI_5_0_HARDWARE_ERROR_NOTIFICATION_SCI                 0x03
#define EFI_ACPI_5_0_HARDWARE_ERROR_NOTIFICATION_NMI                 0x04

///
/// Hardware Error Notification Configuration Write Enable Structure Definition
///
typedef struct {
  UINT16    Type                           : 1;
  UINT16    PollInterval                   : 1;
  UINT16    SwitchToPollingThresholdValue  : 1;
  UINT16    SwitchToPollingThresholdWindow : 1;
  UINT16    ErrorThresholdValue            : 1;
  UINT16    ErrorThresholdWindow           : 1;
  UINT16    Reserved                       : 10;
} EFI_ACPI_5_0_HARDWARE_ERROR_NOTIFICATION_CONFIGURATION_WRITE_ENABLE_STRUCTURE;

///
/// Hardware Error Notification Structure Definition
///
typedef struct {
  UINT8                                                                            Type;
  UINT8                                                                            Length;
  EFI_ACPI_5_0_HARDWARE_ERROR_NOTIFICATION_CONFIGURATION_WRITE_ENABLE_STRUCTURE    ConfigurationWriteEnable;
  UINT32                                                                           PollInterval;
  UINT32                                                                           Vector;
  UINT32                                                                           SwitchToPollingThresholdValue;
  UINT32                                                                           SwitchToPollingThresholdWindow;
  UINT32                                                                           ErrorThresholdValue;
  UINT32                                                                           ErrorThresholdWindow;
} EFI_ACPI_5_0_HARDWARE_ERROR_NOTIFICATION_STRUCTURE;

///
/// IA-32 Architecture Corrected Machine Check Structure Definition
///
typedef struct {
  UINT16                                                Type;
  UINT16                                                SourceId;
  UINT8                                                 Reserved0[2];
  UINT8                                                 Flags;
  UINT8                                                 Enabled;
  UINT32                                                NumberOfRecordsToPreAllocate;
  UINT32                                                MaxSectionsPerRecord;
  EFI_ACPI_5_0_HARDWARE_ERROR_NOTIFICATION_STRUCTURE    NotificationStructure;
  UINT8                                                 NumberOfHardwareBanks;
  UINT8                                                 Reserved1[3];
} EFI_ACPI_5_0_IA32_ARCHITECTURE_CORRECTED_MACHINE_CHECK_STRUCTURE;

///
/// IA-32 Architecture NMI Error Structure Definition
///
typedef struct {
  UINT16    Type;
  UINT16    SourceId;
  UINT8     Reserved0[2];
  UINT32    NumberOfRecordsToPreAllocate;
  UINT32    MaxSectionsPerRecord;
  UINT32    MaxRawDataLength;
} EFI_ACPI_5_0_IA32_ARCHITECTURE_NMI_ERROR_STRUCTURE;

///
/// PCI Express Root Port AER Structure Definition
///
typedef struct {
  UINT16    Type;
  UINT16    SourceId;
  UINT8     Reserved0[2];
  UINT8     Flags;
  UINT8     Enabled;
  UINT32    NumberOfRecordsToPreAllocate;
  UINT32    MaxSectionsPerRecord;
  UINT32    Bus;
  UINT16    Device;
  UINT16    Function;
  UINT16    DeviceControl;
  UINT8     Reserved1[2];
  UINT32    UncorrectableErrorMask;
  UINT32    UncorrectableErrorSeverity;
  UINT32    CorrectableErrorMask;
  UINT32    AdvancedErrorCapabilitiesAndControl;
  UINT32    RootErrorCommand;
} EFI_ACPI_5_0_PCI_EXPRESS_ROOT_PORT_AER_STRUCTURE;

///
/// PCI Express Device AER Structure Definition
///
typedef struct {
  UINT16    Type;
  UINT16    SourceId;
  UINT8     Reserved0[2];
  UINT8     Flags;
  UINT8     Enabled;
  UINT32    NumberOfRecordsToPreAllocate;
  UINT32    MaxSectionsPerRecord;
  UINT32    Bus;
  UINT16    Device;
  UINT16    Function;
  UINT16    DeviceControl;
  UINT8     Reserved1[2];
  UINT32    UncorrectableErrorMask;
  UINT32    UncorrectableErrorSeverity;
  UINT32    CorrectableErrorMask;
  UINT32    AdvancedErrorCapabilitiesAndControl;
} EFI_ACPI_5_0_PCI_EXPRESS_DEVICE_AER_STRUCTURE;

///
/// PCI Express Bridge AER Structure Definition
///
typedef struct {
  UINT16    Type;
  UINT16    SourceId;
  UINT8     Reserved0[2];
  UINT8     Flags;
  UINT8     Enabled;
  UINT32    NumberOfRecordsToPreAllocate;
  UINT32    MaxSectionsPerRecord;
  UINT32    Bus;
  UINT16    Device;
  UINT16    Function;
  UINT16    DeviceControl;
  UINT8     Reserved1[2];
  UINT32    UncorrectableErrorMask;
  UINT32    UncorrectableErrorSeverity;
  UINT32    CorrectableErrorMask;
  UINT32    AdvancedErrorCapabilitiesAndControl;
  UINT32    SecondaryUncorrectableErrorMask;
  UINT32    SecondaryUncorrectableErrorSeverity;
  UINT32    SecondaryAdvancedErrorCapabilitiesAndControl;
} EFI_ACPI_5_0_PCI_EXPRESS_BRIDGE_AER_STRUCTURE;

///
/// Generic Hardware Error Source Structure Definition
///
typedef struct {
  UINT16                                                Type;
  UINT16                                                SourceId;
  UINT16                                                RelatedSourceId;
  UINT8                                                 Flags;
  UINT8                                                 Enabled;
  UINT32                                                NumberOfRecordsToPreAllocate;
  UINT32                                                MaxSectionsPerRecord;
  UINT32                                                MaxRawDataLength;
  EFI_ACPI_5_0_GENERIC_ADDRESS_STRUCTURE                ErrorStatusAddress;
  EFI_ACPI_5_0_HARDWARE_ERROR_NOTIFICATION_STRUCTURE    NotificationStructure;
  UINT32                                                ErrorStatusBlockLength;
} EFI_ACPI_5_0_GENERIC_HARDWARE_ERROR_SOURCE_STRUCTURE;

///
/// Generic Error Status Definition
///
typedef struct {
  EFI_ACPI_5_0_ERROR_BLOCK_STATUS    BlockStatus;
  UINT32                             RawDataOffset;
  UINT32                             RawDataLength;
  UINT32                             DataLength;
  UINT32                             ErrorSeverity;
} EFI_ACPI_5_0_GENERIC_ERROR_STATUS_STRUCTURE;

///
/// ERST - Error Record Serialization Table
///
typedef struct {
  EFI_ACPI_DESCRIPTION_HEADER    Header;
  UINT32                         SerializationHeaderSize;
  UINT8                          Reserved0[4];
  UINT32                         InstructionEntryCount;
} EFI_ACPI_5_0_ERROR_RECORD_SERIALIZATION_TABLE_HEADER;

///
/// ERST Version (as defined in ACPI 5.0 spec.)
///
#define EFI_ACPI_5_0_ERROR_RECORD_SERIALIZATION_TABLE_REVISION  0x01

///
/// ERST Serialization Actions
///
#define EFI_ACPI_5_0_ERST_BEGIN_WRITE_OPERATION                   0x00
#define EFI_ACPI_5_0_ERST_BEGIN_READ_OPERATION                    0x01
#define EFI_ACPI_5_0_ERST_BEGIN_CLEAR_OPERATION                   0x02
#define EFI_ACPI_5_0_ERST_END_OPERATION                           0x03
#define EFI_ACPI_5_0_ERST_SET_RECORD_OFFSET                       0x04
#define EFI_ACPI_5_0_ERST_EXECUTE_OPERATION                       0x05
#define EFI_ACPI_5_0_ERST_CHECK_BUSY_STATUS                       0x06
#define EFI_ACPI_5_0_ERST_GET_COMMAND_STATUS                      0x07
#define EFI_ACPI_5_0_ERST_GET_RECORD_IDENTIFIER                   0x08
#define EFI_ACPI_5_0_ERST_SET_RECORD_IDENTIFIER                   0x09
#define EFI_ACPI_5_0_ERST_GET_RECORD_COUNT                        0x0A
#define EFI_ACPI_5_0_ERST_BEGIN_DUMMY_WRITE_OPERATION             0x0B
#define EFI_ACPI_5_0_ERST_GET_ERROR_LOG_ADDRESS_RANGE             0x0D
#define EFI_ACPI_5_0_ERST_GET_ERROR_LOG_ADDRESS_RANGE_LENGTH      0x0E
#define EFI_ACPI_5_0_ERST_GET_ERROR_LOG_ADDRESS_RANGE_ATTRIBUTES  0x0F

///
/// ERST Action Command Status
///
#define EFI_ACPI_5_0_ERST_STATUS_SUCCESS                 0x00
#define EFI_ACPI_5_0_ERST_STATUS_NOT_ENOUGH_SPACE        0x01
#define EFI_ACPI_5_0_ERST_STATUS_HARDWARE_NOT_AVAILABLE  0x02
#define EFI_ACPI_5_0_ERST_STATUS_FAILED                  0x03
#define EFI_ACPI_5_0_ERST_STATUS_RECORD_STORE_EMPTY      0x04
#define EFI_ACPI_5_0_ERST_STATUS_RECORD_NOT_FOUND        0x05

///
/// ERST Serialization Instructions
///
#define EFI_ACPI_5_0_ERST_READ_REGISTER                  0x00
#define EFI_ACPI_5_0_ERST_READ_REGISTER_VALUE            0x01
#define EFI_ACPI_5_0_ERST_WRITE_REGISTER                 0x02
#define EFI_ACPI_5_0_ERST_WRITE_REGISTER_VALUE           0x03
#define EFI_ACPI_5_0_ERST_NOOP                           0x04
#define EFI_ACPI_5_0_ERST_LOAD_VAR1                      0x05
#define EFI_ACPI_5_0_ERST_LOAD_VAR2                      0x06
#define EFI_ACPI_5_0_ERST_STORE_VAR1                     0x07
#define EFI_ACPI_5_0_ERST_ADD                            0x08
#define EFI_ACPI_5_0_ERST_SUBTRACT                       0x09
#define EFI_ACPI_5_0_ERST_ADD_VALUE                      0x0A
#define EFI_ACPI_5_0_ERST_SUBTRACT_VALUE                 0x0B
#define EFI_ACPI_5_0_ERST_STALL                          0x0C
#define EFI_ACPI_5_0_ERST_STALL_WHILE_TRUE               0x0D
#define EFI_ACPI_5_0_ERST_SKIP_NEXT_INSTRUCTION_IF_TRUE  0x0E
#define EFI_ACPI_5_0_ERST_GOTO                           0x0F
#define EFI_ACPI_5_0_ERST_SET_SRC_ADDRESS_BASE           0x10
#define EFI_ACPI_5_0_ERST_SET_DST_ADDRESS_BASE           0x11
#define EFI_ACPI_5_0_ERST_MOVE_DATA                      0x12

///
/// ERST Instruction Flags
///
#define EFI_ACPI_5_0_ERST_PRESERVE_REGISTER  0x01

///
/// ERST Serialization Instruction Entry
///
typedef struct {
  UINT8                                     SerializationAction;
  UINT8                                     Instruction;
  UINT8                                     Flags;
  UINT8                                     Reserved0;
  EFI_ACPI_5_0_GENERIC_ADDRESS_STRUCTURE    RegisterRegion;
  UINT64                                    Value;
  UINT64                                    Mask;
} EFI_ACPI_5_0_ERST_SERIALIZATION_INSTRUCTION_ENTRY;

///
/// EINJ - Error Injection Table
///
typedef struct {
  EFI_ACPI_DESCRIPTION_HEADER    Header;
  UINT32                         InjectionHeaderSize;
  UINT8                          InjectionFlags;
  UINT8                          Reserved0[3];
  UINT32                         InjectionEntryCount;
} EFI_ACPI_5_0_ERROR_INJECTION_TABLE_HEADER;

///
/// EINJ Version (as defined in ACPI 5.0 spec.)
///
#define EFI_ACPI_5_0_ERROR_INJECTION_TABLE_REVISION  0x01

///
/// EINJ Error Injection Actions
///
#define EFI_ACPI_5_0_EINJ_BEGIN_INJECTION_OPERATION       0x00
#define EFI_ACPI_5_0_EINJ_GET_TRIGGER_ERROR_ACTION_TABLE  0x01
#define EFI_ACPI_5_0_EINJ_SET_ERROR_TYPE                  0x02
#define EFI_ACPI_5_0_EINJ_GET_ERROR_TYPE                  0x03
#define EFI_ACPI_5_0_EINJ_END_OPERATION                   0x04
#define EFI_ACPI_5_0_EINJ_EXECUTE_OPERATION               0x05
#define EFI_ACPI_5_0_EINJ_CHECK_BUSY_STATUS               0x06
#define EFI_ACPI_5_0_EINJ_GET_COMMAND_STATUS              0x07
#define EFI_ACPI_5_0_EINJ_TRIGGER_ERROR                   0xFF

///
/// EINJ Action Command Status
///
#define EFI_ACPI_5_0_EINJ_STATUS_SUCCESS          0x00
#define EFI_ACPI_5_0_EINJ_STATUS_UNKNOWN_FAILURE  0x01
#define EFI_ACPI_5_0_EINJ_STATUS_INVALID_ACCESS   0x02

///
/// EINJ Error Type Definition
///
#define EFI_ACPI_5_0_EINJ_ERROR_PROCESSOR_CORRECTABLE               (1 << 0)
#define EFI_ACPI_5_0_EINJ_ERROR_PROCESSOR_UNCORRECTABLE_NONFATAL    (1 << 1)
#define EFI_ACPI_5_0_EINJ_ERROR_PROCESSOR_UNCORRECTABLE_FATAL       (1 << 2)
#define EFI_ACPI_5_0_EINJ_ERROR_MEMORY_CORRECTABLE                  (1 << 3)
#define EFI_ACPI_5_0_EINJ_ERROR_MEMORY_UNCORRECTABLE_NONFATAL       (1 << 4)
#define EFI_ACPI_5_0_EINJ_ERROR_MEMORY_UNCORRECTABLE_FATAL          (1 << 5)
#define EFI_ACPI_5_0_EINJ_ERROR_PCI_EXPRESS_CORRECTABLE             (1 << 6)
#define EFI_ACPI_5_0_EINJ_ERROR_PCI_EXPRESS_UNCORRECTABLE_NONFATAL  (1 << 7)
#define EFI_ACPI_5_0_EINJ_ERROR_PCI_EXPRESS_UNCORRECTABLE_FATAL     (1 << 8)
#define EFI_ACPI_5_0_EINJ_ERROR_PLATFORM_CORRECTABLE                (1 << 9)
#define EFI_ACPI_5_0_EINJ_ERROR_PLATFORM_UNCORRECTABLE_NONFATAL     (1 << 10)
#define EFI_ACPI_5_0_EINJ_ERROR_PLATFORM_UNCORRECTABLE_FATAL        (1 << 11)

///
/// EINJ Injection Instructions
///
#define EFI_ACPI_5_0_EINJ_READ_REGISTER         0x00
#define EFI_ACPI_5_0_EINJ_READ_REGISTER_VALUE   0x01
#define EFI_ACPI_5_0_EINJ_WRITE_REGISTER        0x02
#define EFI_ACPI_5_0_EINJ_WRITE_REGISTER_VALUE  0x03
#define EFI_ACPI_5_0_EINJ_NOOP                  0x04

///
/// EINJ Instruction Flags
///
#define EFI_ACPI_5_0_EINJ_PRESERVE_REGISTER  0x01

///
/// EINJ Injection Instruction Entry
///
typedef struct {
  UINT8                                     InjectionAction;
  UINT8                                     Instruction;
  UINT8                                     Flags;
  UINT8                                     Reserved0;
  EFI_ACPI_5_0_GENERIC_ADDRESS_STRUCTURE    RegisterRegion;
  UINT64                                    Value;
  UINT64                                    Mask;
} EFI_ACPI_5_0_EINJ_INJECTION_INSTRUCTION_ENTRY;

///
/// EINJ Trigger Action Table
///
typedef struct {
  UINT32    HeaderSize;
  UINT32    Revision;
  UINT32    TableSize;
  UINT32    EntryCount;
} EFI_ACPI_5_0_EINJ_TRIGGER_ACTION_TABLE;

///
/// Platform Communications Channel Table (PCCT)
///
typedef struct {
  EFI_ACPI_DESCRIPTION_HEADER    Header;
  UINT32                         Flags;
  UINT64                         Reserved;
} EFI_ACPI_5_0_PLATFORM_COMMUNICATION_CHANNEL_TABLE_HEADER;

///
/// PCCT Version (as defined in ACPI 5.0 spec.)
///
#define EFI_ACPI_5_0_PLATFORM_COMMUNICATION_CHANNEL_TABLE_REVISION  0x01

///
/// PCCT Global Flags
///
#define EFI_ACPI_5_0_PCCT_FLAGS_SCI_DOORBELL  BIT0

//
// PCCT Subspace type

/// PCC Subspace Structure Header
///
typedef struct {
  UINT8    Type;
  UINT8    Length;
} EFI_ACPI_5_0_PCCT_SUBSPACE_HEADER;

///
/// Generic Communications Subspace Structure
///
typedef struct {
  UINT8                                     Type;
  UINT8                                     Length;
  UINT8                                     Reserved[6];
  UINT64                                    BaseAddress;
  UINT64                                    AddressLength;
  EFI_ACPI_5_0_GENERIC_ADDRESS_STRUCTURE    DoorbellRegister;
  UINT64                                    DoorbellPreserve;
  UINT64                                    DoorbellWrite;
  UINT32                                    NominalLatency;
  UINT32                                    MaximumPeriodicAccessRate;
  UINT16                                    MinimumRequestTurnaroundTime;
} EFI_ACPI_5_0_PCCT_SUBSPACE_GENERIC;

///

///

typedef struct {
  UINT8    Command;
  UINT8    Reserved    : 7;
  UINT8    GenerateSci : 1;
} EFI_ACPI_5_0_PCCT_GENERIC_SHARED_MEMORY_REGION_COMMAND;

typedef struct {
  UINT8    CommandComplete      : 1;
  UINT8    SciDoorbell          : 1;
  UINT8    Error                : 1;
  UINT8    PlatformNotification : 1;
  UINT8    Reserved             : 4;
  UINT8    Reserved1;
} EFI_ACPI_5_0_PCCT_GENERIC_SHARED_MEMORY_REGION_STATUS;

typedef struct {

/// "WAET" Windows ACPI Emulated Devices Table
///
#define EFI_ACPI_5_0_WINDOWS_ACPI_EMULATED_DEVICES_TABLE_SIGNATURE  SIGNATURE_32('W', 'A', 'E', 'T')
#define EFI_ACPI_5_0_WINDOWS_ACPI_ENLIGHTENMENT_TABLE_SIGNATURE     EFI_ACPI_5_0_WINDOWS_ACPI_EMULATED_DEVICES_TABLE_SIGNATURE

///
/// "WDAT" Watchdog Action Table

Lines 2-8 Link Here

(-)b/sys/contrib/edk2/Include/IndustryStandard/Acpi51.h (-807 / +823 lines)
2	ACPI 5.1 definitions from the ACPI Specification Revision 5.1 Errata B January, 2016.	2	ACPI 5.1 definitions from the ACPI Specification Revision 5.1 Errata B January, 2016.
3		3
4	Copyright (c) 2014 Hewlett-Packard Development Company, L.P.<BR>	4	Copyright (c) 2014 Hewlett-Packard Development Company, L.P.<BR>
5	Copyright (c) 2014 - 2018, Intel Corporation. All rights reserved.<BR>	5	Copyright (c) 2014 - 2022, Intel Corporation. All rights reserved.<BR>
6	(C) Copyright 2015 Hewlett Packard Enterprise Development LP<BR>	6	(C) Copyright 2015 Hewlett Packard Enterprise Development LP<BR>
7	Copyright (c) 2020, ARM Ltd. All rights reserved.<BR>	7	Copyright (c) 2020, ARM Ltd. All rights reserved.<BR>
8	SPDX-License-Identifier: BSD-2-Clause-Patent	8	SPDX-License-Identifier: BSD-2-Clause-Patent
Lines 13-18 Link Here
13		13
14	#include <IndustryStandard/Acpi50.h>	14	#include <IndustryStandard/Acpi50.h>
15		15
		16	///
		17	/// _PSD Revision for ACPI 5.1
		18	///
		19	#define EFI_ACPI_5_1_AML_PSD_REVISION 0
		20
		21	///
		22	/// _CPC Revision for ACPI 5.1
		23	///
		24	#define EFI_ACPI_5_1_AML_CPC_REVISION 2
		25
16	//	26	//
17	// Ensure proper structure formats	27	// Ensure proper structure formats
18	//	28	//
Lines 22-42 Link Here
22	/// ACPI 5.1 Generic Address Space definition	32	/// ACPI 5.1 Generic Address Space definition
23	///	33	///
24	typedef struct {	34	typedef struct {
25	UINT8 AddressSpaceId;	35	UINT8 AddressSpaceId;
26	UINT8 RegisterBitWidth;	36	UINT8 RegisterBitWidth;
27	UINT8 RegisterBitOffset;	37	UINT8 RegisterBitOffset;
28	UINT8 AccessSize;	38	UINT8 AccessSize;
29	UINT64 Address;	39	UINT64 Address;
30	} EFI_ACPI_5_1_GENERIC_ADDRESS_STRUCTURE;	40	} EFI_ACPI_5_1_GENERIC_ADDRESS_STRUCTURE;
31		41
32	//	42	//
33	// Generic Address Space Address IDs	43	// Generic Address Space Address IDs
34	//	44	//
35	#define EFI_ACPI_5_1_SYSTEM_MEMORY 0	45	#define EFI_ACPI_5_1_SYSTEM_MEMORY 0
36	#define EFI_ACPI_5_1_SYSTEM_IO 1	46	#define EFI_ACPI_5_1_SYSTEM_IO 1
37	#define EFI_ACPI_5_1_PCI_CONFIGURATION_SPACE 2	47	#define EFI_ACPI_5_1_PCI_CONFIGURATION_SPACE 2
38	#define EFI_ACPI_5_1_EMBEDDED_CONTROLLER 3	48	#define EFI_ACPI_5_1_EMBEDDED_CONTROLLER 3
39	#define EFI_ACPI_5_1_SMBUS 4	49	#define EFI_ACPI_5_1_SMBUS 4
40	#define EFI_ACPI_5_1_PLATFORM_COMMUNICATION_CHANNEL 0x0A	50	#define EFI_ACPI_5_1_PLATFORM_COMMUNICATION_CHANNEL 0x0A
41	#define EFI_ACPI_5_1_FUNCTIONAL_FIXED_HARDWARE 0x7F	51	#define EFI_ACPI_5_1_FUNCTIONAL_FIXED_HARDWARE 0x7F
42		52
Lines 57-85 typedef struct { Link Here
57	/// Root System Description Pointer Structure	67	/// Root System Description Pointer Structure
58	///	68	///
59	typedef struct {	69	typedef struct {
60	UINT64 Signature;	70	UINT64 Signature;
61	UINT8 Checksum;	71	UINT8 Checksum;
62	UINT8 OemId[6];	72	UINT8 OemId[6];
63	UINT8 Revision;	73	UINT8 Revision;
64	UINT32 RsdtAddress;	74	UINT32 RsdtAddress;
65	UINT32 Length;	75	UINT32 Length;
66	UINT64 XsdtAddress;	76	UINT64 XsdtAddress;
67	UINT8 ExtendedChecksum;	77	UINT8 ExtendedChecksum;
68	UINT8 Reserved[3];	78	UINT8 Reserved[3];
69	} EFI_ACPI_5_1_ROOT_SYSTEM_DESCRIPTION_POINTER;	79	} EFI_ACPI_5_1_ROOT_SYSTEM_DESCRIPTION_POINTER;
70		80
71	///	81	///
72	/// RSD_PTR Revision (as defined in ACPI 5.1 spec.)	82	/// RSD_PTR Revision (as defined in ACPI 5.1 spec.)
73	///	83	///
74	#define EFI_ACPI_5_1_ROOT_SYSTEM_DESCRIPTION_POINTER_REVISION 0x02 ///< ACPISpec (Revision 5.1) says current value is 2	84	#define EFI_ACPI_5_1_ROOT_SYSTEM_DESCRIPTION_POINTER_REVISION 0x02 ///< ACPISpec (Revision 5.1) says current value is 2
75		85
76	///	86	///
77	/// Common table header, this prefaces all ACPI tables, including FACS, but	87	/// Common table header, this prefaces all ACPI tables, including FACS, but
78	/// excluding the RSD PTR structure	88	/// excluding the RSD PTR structure
79	///	89	///
80	typedef struct {	90	typedef struct {
81	UINT32 Signature;	91	UINT32 Signature;
82	UINT32 Length;	92	UINT32 Length;
83	} EFI_ACPI_5_1_COMMON_HEADER;	93	} EFI_ACPI_5_1_COMMON_HEADER;
84		94
85	//	95	//
Lines 91-97 typedef struct { Link Here
91	///	101	///
92	/// RSDT Revision (as defined in ACPI 5.1 spec.)	102	/// RSDT Revision (as defined in ACPI 5.1 spec.)
93	///	103	///
94	#define EFI_ACPI_5_1_ROOT_SYSTEM_DESCRIPTION_TABLE_REVISION 0x01	104	#define EFI_ACPI_5_1_ROOT_SYSTEM_DESCRIPTION_TABLE_REVISION 0x01
95		105
96	//	106	//
97	// Extended System Description Table	107	// Extended System Description Table
Lines 102-174 typedef struct { Link Here
102	///	112	///
103	/// XSDT Revision (as defined in ACPI 5.1 spec.)	113	/// XSDT Revision (as defined in ACPI 5.1 spec.)
104	///	114	///
105	#define EFI_ACPI_5_1_EXTENDED_SYSTEM_DESCRIPTION_TABLE_REVISION 0x01	115	#define EFI_ACPI_5_1_EXTENDED_SYSTEM_DESCRIPTION_TABLE_REVISION 0x01
106		116
107	///	117	///
108	/// Fixed ACPI Description Table Structure (FADT)	118	/// Fixed ACPI Description Table Structure (FADT)
109	///	119	///
110	typedef struct {	120	typedef struct {
111	EFI_ACPI_DESCRIPTION_HEADER Header;	121	EFI_ACPI_DESCRIPTION_HEADER Header;
112	UINT32 FirmwareCtrl;	122	UINT32 FirmwareCtrl;
113	UINT32 Dsdt;	123	UINT32 Dsdt;
114	UINT8 Reserved0;	124	UINT8 Reserved0;
115	UINT8 PreferredPmProfile;	125	UINT8 PreferredPmProfile;
116	UINT16 SciInt;	126	UINT16 SciInt;
117	UINT32 SmiCmd;	127	UINT32 SmiCmd;
118	UINT8 AcpiEnable;	128	UINT8 AcpiEnable;
119	UINT8 AcpiDisable;	129	UINT8 AcpiDisable;
120	UINT8 S4BiosReq;	130	UINT8 S4BiosReq;
121	UINT8 PstateCnt;	131	UINT8 PstateCnt;
122	UINT32 Pm1aEvtBlk;	132	UINT32 Pm1aEvtBlk;
123	UINT32 Pm1bEvtBlk;	133	UINT32 Pm1bEvtBlk;
124	UINT32 Pm1aCntBlk;	134	UINT32 Pm1aCntBlk;
125	UINT32 Pm1bCntBlk;	135	UINT32 Pm1bCntBlk;
126	UINT32 Pm2CntBlk;	136	UINT32 Pm2CntBlk;
127	UINT32 PmTmrBlk;	137	UINT32 PmTmrBlk;
128	UINT32 Gpe0Blk;	138	UINT32 Gpe0Blk;
129	UINT32 Gpe1Blk;	139	UINT32 Gpe1Blk;
130	UINT8 Pm1EvtLen;	140	UINT8 Pm1EvtLen;
131	UINT8 Pm1CntLen;	141	UINT8 Pm1CntLen;
132	UINT8 Pm2CntLen;	142	UINT8 Pm2CntLen;
133	UINT8 PmTmrLen;	143	UINT8 PmTmrLen;
134	UINT8 Gpe0BlkLen;	144	UINT8 Gpe0BlkLen;
135	UINT8 Gpe1BlkLen;	145	UINT8 Gpe1BlkLen;
136	UINT8 Gpe1Base;	146	UINT8 Gpe1Base;
137	UINT8 CstCnt;	147	UINT8 CstCnt;
138	UINT16 PLvl2Lat;	148	UINT16 PLvl2Lat;
139	UINT16 PLvl3Lat;	149	UINT16 PLvl3Lat;
140	UINT16 FlushSize;	150	UINT16 FlushSize;
141	UINT16 FlushStride;	151	UINT16 FlushStride;
142	UINT8 DutyOffset;	152	UINT8 DutyOffset;
143	UINT8 DutyWidth;	153	UINT8 DutyWidth;
144	UINT8 DayAlrm;	154	UINT8 DayAlrm;
145	UINT8 MonAlrm;	155	UINT8 MonAlrm;
146	UINT8 Century;	156	UINT8 Century;
147	UINT16 IaPcBootArch;	157	UINT16 IaPcBootArch;
148	UINT8 Reserved1;	158	UINT8 Reserved1;
149	UINT32 Flags;	159	UINT32 Flags;
150	EFI_ACPI_5_1_GENERIC_ADDRESS_STRUCTURE ResetReg;	160	EFI_ACPI_5_1_GENERIC_ADDRESS_STRUCTURE ResetReg;
151	UINT8 ResetValue;	161	UINT8 ResetValue;
152	UINT16 ArmBootArch;	162	UINT16 ArmBootArch;
153	UINT8 MinorVersion;	163	UINT8 MinorVersion;
154	UINT64 XFirmwareCtrl;	164	UINT64 XFirmwareCtrl;
155	UINT64 XDsdt;	165	UINT64 XDsdt;
156	EFI_ACPI_5_1_GENERIC_ADDRESS_STRUCTURE XPm1aEvtBlk;	166	EFI_ACPI_5_1_GENERIC_ADDRESS_STRUCTURE XPm1aEvtBlk;
157	EFI_ACPI_5_1_GENERIC_ADDRESS_STRUCTURE XPm1bEvtBlk;	167	EFI_ACPI_5_1_GENERIC_ADDRESS_STRUCTURE XPm1bEvtBlk;
158	EFI_ACPI_5_1_GENERIC_ADDRESS_STRUCTURE XPm1aCntBlk;	168	EFI_ACPI_5_1_GENERIC_ADDRESS_STRUCTURE XPm1aCntBlk;
159	EFI_ACPI_5_1_GENERIC_ADDRESS_STRUCTURE XPm1bCntBlk;	169	EFI_ACPI_5_1_GENERIC_ADDRESS_STRUCTURE XPm1bCntBlk;
160	EFI_ACPI_5_1_GENERIC_ADDRESS_STRUCTURE XPm2CntBlk;	170	EFI_ACPI_5_1_GENERIC_ADDRESS_STRUCTURE XPm2CntBlk;
161	EFI_ACPI_5_1_GENERIC_ADDRESS_STRUCTURE XPmTmrBlk;	171	EFI_ACPI_5_1_GENERIC_ADDRESS_STRUCTURE XPmTmrBlk;
162	EFI_ACPI_5_1_GENERIC_ADDRESS_STRUCTURE XGpe0Blk;	172	EFI_ACPI_5_1_GENERIC_ADDRESS_STRUCTURE XGpe0Blk;
163	EFI_ACPI_5_1_GENERIC_ADDRESS_STRUCTURE XGpe1Blk;	173	EFI_ACPI_5_1_GENERIC_ADDRESS_STRUCTURE XGpe1Blk;
164	EFI_ACPI_5_1_GENERIC_ADDRESS_STRUCTURE SleepControlReg;	174	EFI_ACPI_5_1_GENERIC_ADDRESS_STRUCTURE SleepControlReg;
165	EFI_ACPI_5_1_GENERIC_ADDRESS_STRUCTURE SleepStatusReg;	175	EFI_ACPI_5_1_GENERIC_ADDRESS_STRUCTURE SleepStatusReg;
166	} EFI_ACPI_5_1_FIXED_ACPI_DESCRIPTION_TABLE;	176	} EFI_ACPI_5_1_FIXED_ACPI_DESCRIPTION_TABLE;
167		177
168	///	178	///
169	/// FADT Version (as defined in ACPI 5.1 spec.)	179	/// FADT Version (as defined in ACPI 5.1 spec.)
170	///	180	///
171	#define EFI_ACPI_5_1_FIXED_ACPI_DESCRIPTION_TABLE_REVISION 0x05	181	#define EFI_ACPI_5_1_FIXED_ACPI_DESCRIPTION_TABLE_REVISION 0x05
172	#define EFI_ACPI_5_1_FIXED_ACPI_DESCRIPTION_TABLE_MINOR_REVISION 0x01	182	#define EFI_ACPI_5_1_FIXED_ACPI_DESCRIPTION_TABLE_MINOR_REVISION 0x01
173		183
174	//	184	//
Lines 188-249 typedef struct { Link Here
188	// Fixed ACPI Description Table Boot Architecture Flags	198	// Fixed ACPI Description Table Boot Architecture Flags
189	// All other bits are reserved and must be set to 0.	199	// All other bits are reserved and must be set to 0.
190	//	200	//
191	#define EFI_ACPI_5_1_LEGACY_DEVICES BIT0	201	#define EFI_ACPI_5_1_LEGACY_DEVICES BIT0
192	#define EFI_ACPI_5_1_8042 BIT1	202	#define EFI_ACPI_5_1_8042 BIT1
193	#define EFI_ACPI_5_1_VGA_NOT_PRESENT BIT2	203	#define EFI_ACPI_5_1_VGA_NOT_PRESENT BIT2
194	#define EFI_ACPI_5_1_MSI_NOT_SUPPORTED BIT3	204	#define EFI_ACPI_5_1_MSI_NOT_SUPPORTED BIT3
195	#define EFI_ACPI_5_1_PCIE_ASPM_CONTROLS BIT4	205	#define EFI_ACPI_5_1_PCIE_ASPM_CONTROLS BIT4
196	#define EFI_ACPI_5_1_CMOS_RTC_NOT_PRESENT BIT5	206	#define EFI_ACPI_5_1_CMOS_RTC_NOT_PRESENT BIT5
197		207
198	//	208	//
199	// Fixed ACPI Description Table Arm Boot Architecture Flags	209	// Fixed ACPI Description Table Arm Boot Architecture Flags
200	// All other bits are reserved and must be set to 0.	210	// All other bits are reserved and must be set to 0.
201	//	211	//
202	#define EFI_ACPI_5_1_ARM_PSCI_COMPLIANT BIT0	212	#define EFI_ACPI_5_1_ARM_PSCI_COMPLIANT BIT0
203	#define EFI_ACPI_5_1_ARM_PSCI_USE_HVC BIT1	213	#define EFI_ACPI_5_1_ARM_PSCI_USE_HVC BIT1
204		214
205	//	215	//
206	// Fixed ACPI Description Table Fixed Feature Flags	216	// Fixed ACPI Description Table Fixed Feature Flags
207	// All other bits are reserved and must be set to 0.	217	// All other bits are reserved and must be set to 0.
208	//	218	//
209	#define EFI_ACPI_5_1_WBINVD BIT0	219	#define EFI_ACPI_5_1_WBINVD BIT0
210	#define EFI_ACPI_5_1_WBINVD_FLUSH BIT1	220	#define EFI_ACPI_5_1_WBINVD_FLUSH BIT1
211	#define EFI_ACPI_5_1_PROC_C1 BIT2	221	#define EFI_ACPI_5_1_PROC_C1 BIT2
212	#define EFI_ACPI_5_1_P_LVL2_UP BIT3	222	#define EFI_ACPI_5_1_P_LVL2_UP BIT3
213	#define EFI_ACPI_5_1_PWR_BUTTON BIT4	223	#define EFI_ACPI_5_1_PWR_BUTTON BIT4
214	#define EFI_ACPI_5_1_SLP_BUTTON BIT5	224	#define EFI_ACPI_5_1_SLP_BUTTON BIT5
215	#define EFI_ACPI_5_1_FIX_RTC BIT6	225	#define EFI_ACPI_5_1_FIX_RTC BIT6
216	#define EFI_ACPI_5_1_RTC_S4 BIT7	226	#define EFI_ACPI_5_1_RTC_S4 BIT7
217	#define EFI_ACPI_5_1_TMR_VAL_EXT BIT8	227	#define EFI_ACPI_5_1_TMR_VAL_EXT BIT8
218	#define EFI_ACPI_5_1_DCK_CAP BIT9	228	#define EFI_ACPI_5_1_DCK_CAP BIT9
219	#define EFI_ACPI_5_1_RESET_REG_SUP BIT10	229	#define EFI_ACPI_5_1_RESET_REG_SUP BIT10
220	#define EFI_ACPI_5_1_SEALED_CASE BIT11	230	#define EFI_ACPI_5_1_SEALED_CASE BIT11
221	#define EFI_ACPI_5_1_HEADLESS BIT12	231	#define EFI_ACPI_5_1_HEADLESS BIT12
222	#define EFI_ACPI_5_1_CPU_SW_SLP BIT13	232	#define EFI_ACPI_5_1_CPU_SW_SLP BIT13
223	#define EFI_ACPI_5_1_PCI_EXP_WAK BIT14	233	#define EFI_ACPI_5_1_PCI_EXP_WAK BIT14
224	#define EFI_ACPI_5_1_USE_PLATFORM_CLOCK BIT15	234	#define EFI_ACPI_5_1_USE_PLATFORM_CLOCK BIT15
225	#define EFI_ACPI_5_1_S4_RTC_STS_VALID BIT16	235	#define EFI_ACPI_5_1_S4_RTC_STS_VALID BIT16
226	#define EFI_ACPI_5_1_REMOTE_POWER_ON_CAPABLE BIT17	236	#define EFI_ACPI_5_1_REMOTE_POWER_ON_CAPABLE BIT17
227	#define EFI_ACPI_5_1_FORCE_APIC_CLUSTER_MODEL BIT18	237	#define EFI_ACPI_5_1_FORCE_APIC_CLUSTER_MODEL BIT18
228	#define EFI_ACPI_5_1_FORCE_APIC_PHYSICAL_DESTINATION_MODE BIT19	238	#define EFI_ACPI_5_1_FORCE_APIC_PHYSICAL_DESTINATION_MODE BIT19
229	#define EFI_ACPI_5_1_HW_REDUCED_ACPI BIT20	239	#define EFI_ACPI_5_1_HW_REDUCED_ACPI BIT20
230	#define EFI_ACPI_5_1_LOW_POWER_S0_IDLE_CAPABLE BIT21	240	#define EFI_ACPI_5_1_LOW_POWER_S0_IDLE_CAPABLE BIT21
231		241
232	///	242	///
233	/// Firmware ACPI Control Structure	243	/// Firmware ACPI Control Structure
234	///	244	///
235	typedef struct {	245	typedef struct {
236	UINT32 Signature;	246	UINT32 Signature;
237	UINT32 Length;	247	UINT32 Length;
238	UINT32 HardwareSignature;	248	UINT32 HardwareSignature;
239	UINT32 FirmwareWakingVector;	249	UINT32 FirmwareWakingVector;
240	UINT32 GlobalLock;	250	UINT32 GlobalLock;
241	UINT32 Flags;	251	UINT32 Flags;
242	UINT64 XFirmwareWakingVector;	252	UINT64 XFirmwareWakingVector;
243	UINT8 Version;	253	UINT8 Version;
244	UINT8 Reserved0[3];	254	UINT8 Reserved0[3];
245	UINT32 OspmFlags;	255	UINT32 OspmFlags;
246	UINT8 Reserved1[24];	256	UINT8 Reserved1[24];
247	} EFI_ACPI_5_1_FIRMWARE_ACPI_CONTROL_STRUCTURE;	257	} EFI_ACPI_5_1_FIRMWARE_ACPI_CONTROL_STRUCTURE;
248		258
249	///	259	///
Lines 255-268 typedef struct { Link Here
255	/// Firmware Control Structure Feature Flags	265	/// Firmware Control Structure Feature Flags
256	/// All other bits are reserved and must be set to 0.	266	/// All other bits are reserved and must be set to 0.
257	///	267	///
258	#define EFI_ACPI_5_1_S4BIOS_F BIT0	268	#define EFI_ACPI_5_1_S4BIOS_F BIT0
259	#define EFI_ACPI_5_1_64BIT_WAKE_SUPPORTED_F BIT1	269	#define EFI_ACPI_5_1_64BIT_WAKE_SUPPORTED_F BIT1
260		270
261	///	271	///
262	/// OSPM Enabled Firmware Control Structure Flags	272	/// OSPM Enabled Firmware Control Structure Flags
263	/// All other bits are reserved and must be set to 0.	273	/// All other bits are reserved and must be set to 0.
264	///	274	///
265	#define EFI_ACPI_5_1_OSPM_64BIT_WAKE_F BIT0	275	#define EFI_ACPI_5_1_OSPM_64BIT_WAKE_F BIT0
266		276
267	//	277	//
268	// Differentiated System Description Table,	278	// Differentiated System Description Table,
Lines 271-299 typedef struct { Link Here
271	// no definition needed as they are common description table header, the same with	281	// no definition needed as they are common description table header, the same with
272	// EFI_ACPI_DESCRIPTION_HEADER, followed by a definition block.	282	// EFI_ACPI_DESCRIPTION_HEADER, followed by a definition block.
273	//	283	//
274	#define EFI_ACPI_5_1_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_REVISION 0x02	284	#define EFI_ACPI_5_1_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_REVISION 0x02
275	#define EFI_ACPI_5_1_SECONDARY_SYSTEM_DESCRIPTION_TABLE_REVISION 0x02	285	#define EFI_ACPI_5_1_SECONDARY_SYSTEM_DESCRIPTION_TABLE_REVISION 0x02
276		286
277	///	287	///
278	/// Multiple APIC Description Table header definition. The rest of the table	288	/// Multiple APIC Description Table header definition. The rest of the table
279	/// must be defined in a platform specific manner.	289	/// must be defined in a platform specific manner.
280	///	290	///
281	typedef struct {	291	typedef struct {
282	EFI_ACPI_DESCRIPTION_HEADER Header;	292	EFI_ACPI_DESCRIPTION_HEADER Header;
283	UINT32 LocalApicAddress;	293	UINT32 LocalApicAddress;
284	UINT32 Flags;	294	UINT32 Flags;
285	} EFI_ACPI_5_1_MULTIPLE_APIC_DESCRIPTION_TABLE_HEADER;	295	} EFI_ACPI_5_1_MULTIPLE_APIC_DESCRIPTION_TABLE_HEADER;
286		296
287	///	297	///
288	/// MADT Revision (as defined in ACPI 5.1 spec.)	298	/// MADT Revision (as defined in ACPI 5.1 spec.)
289	///	299	///
290	#define EFI_ACPI_5_1_MULTIPLE_APIC_DESCRIPTION_TABLE_REVISION 0x03	300	#define EFI_ACPI_5_1_MULTIPLE_APIC_DESCRIPTION_TABLE_REVISION 0x03
291		301
292	///	302	///
293	/// Multiple APIC Flags	303	/// Multiple APIC Flags
294	/// All other bits are reserved and must be set to 0.	304	/// All other bits are reserved and must be set to 0.
295	///	305	///
296	#define EFI_ACPI_5_1_PCAT_COMPAT BIT0	306	#define EFI_ACPI_5_1_PCAT_COMPAT BIT0
297		307
298	//	308	//
299	// Multiple APIC Description Table APIC structure types	309	// Multiple APIC Description Table APIC structure types
Lines 324-380 typedef struct { Link Here
324	/// Processor Local APIC Structure Definition	334	/// Processor Local APIC Structure Definition
325	///	335	///
326	typedef struct {	336	typedef struct {
327	UINT8 Type;	337	UINT8 Type;
328	UINT8 Length;	338	UINT8 Length;
329	UINT8 AcpiProcessorId;	339	UINT8 AcpiProcessorId;
330	UINT8 ApicId;	340	UINT8 ApicId;
331	UINT32 Flags;	341	UINT32 Flags;
332	} EFI_ACPI_5_1_PROCESSOR_LOCAL_APIC_STRUCTURE;	342	} EFI_ACPI_5_1_PROCESSOR_LOCAL_APIC_STRUCTURE;
333		343
334	///	344	///
335	/// Local APIC Flags. All other bits are reserved and must be 0.	345	/// Local APIC Flags. All other bits are reserved and must be 0.
336	///	346	///
337	#define EFI_ACPI_5_1_LOCAL_APIC_ENABLED BIT0	347	#define EFI_ACPI_5_1_LOCAL_APIC_ENABLED BIT0
338		348
339	///	349	///
340	/// IO APIC Structure	350	/// IO APIC Structure
341	///	351	///
342	typedef struct {	352	typedef struct {
343	UINT8 Type;	353	UINT8 Type;
344	UINT8 Length;	354	UINT8 Length;
345	UINT8 IoApicId;	355	UINT8 IoApicId;
346	UINT8 Reserved;	356	UINT8 Reserved;
347	UINT32 IoApicAddress;	357	UINT32 IoApicAddress;
348	UINT32 GlobalSystemInterruptBase;	358	UINT32 GlobalSystemInterruptBase;
349	} EFI_ACPI_5_1_IO_APIC_STRUCTURE;	359	} EFI_ACPI_5_1_IO_APIC_STRUCTURE;
350		360
351	///	361	///
352	/// Interrupt Source Override Structure	362	/// Interrupt Source Override Structure
353	///	363	///
354	typedef struct {	364	typedef struct {
355	UINT8 Type;	365	UINT8 Type;
356	UINT8 Length;	366	UINT8 Length;
357	UINT8 Bus;	367	UINT8 Bus;
358	UINT8 Source;	368	UINT8 Source;
359	UINT32 GlobalSystemInterrupt;	369	UINT32 GlobalSystemInterrupt;
360	UINT16 Flags;	370	UINT16 Flags;
361	} EFI_ACPI_5_1_INTERRUPT_SOURCE_OVERRIDE_STRUCTURE;	371	} EFI_ACPI_5_1_INTERRUPT_SOURCE_OVERRIDE_STRUCTURE;
362		372
363	///	373	///
364	/// Platform Interrupt Sources Structure Definition	374	/// Platform Interrupt Sources Structure Definition
365	///	375	///
366	typedef struct {	376	typedef struct {
367	UINT8 Type;	377	UINT8 Type;
368	UINT8 Length;	378	UINT8 Length;
369	UINT16 Flags;	379	UINT16 Flags;
370	UINT8 InterruptType;	380	UINT8 InterruptType;
371	UINT8 ProcessorId;	381	UINT8 ProcessorId;
372	UINT8 ProcessorEid;	382	UINT8 ProcessorEid;
373	UINT8 IoSapicVector;	383	UINT8 IoSapicVector;
374	UINT32 GlobalSystemInterrupt;	384	UINT32 GlobalSystemInterrupt;
375	UINT32 PlatformInterruptSourceFlags;	385	UINT32 PlatformInterruptSourceFlags;
376	UINT8 CpeiProcessorOverride;	386	UINT8 CpeiProcessorOverride;
377	UINT8 Reserved[31];	387	UINT8 Reserved[31];
378	} EFI_ACPI_5_1_PLATFORM_INTERRUPT_APIC_STRUCTURE;	388	} EFI_ACPI_5_1_PLATFORM_INTERRUPT_APIC_STRUCTURE;
379		389
380	//	390	//
Lines 388-430 typedef struct { Link Here
388	/// Non-Maskable Interrupt Source Structure	398	/// Non-Maskable Interrupt Source Structure
389	///	399	///
390	typedef struct {	400	typedef struct {
391	UINT8 Type;	401	UINT8 Type;
392	UINT8 Length;	402	UINT8 Length;
393	UINT16 Flags;	403	UINT16 Flags;
394	UINT32 GlobalSystemInterrupt;	404	UINT32 GlobalSystemInterrupt;
395	} EFI_ACPI_5_1_NON_MASKABLE_INTERRUPT_SOURCE_STRUCTURE;	405	} EFI_ACPI_5_1_NON_MASKABLE_INTERRUPT_SOURCE_STRUCTURE;
396		406
397	///	407	///
398	/// Local APIC NMI Structure	408	/// Local APIC NMI Structure
399	///	409	///
400	typedef struct {	410	typedef struct {
401	UINT8 Type;	411	UINT8 Type;
402	UINT8 Length;	412	UINT8 Length;
403	UINT8 AcpiProcessorId;	413	UINT8 AcpiProcessorId;
404	UINT16 Flags;	414	UINT16 Flags;
405	UINT8 LocalApicLint;	415	UINT8 LocalApicLint;
406	} EFI_ACPI_5_1_LOCAL_APIC_NMI_STRUCTURE;	416	} EFI_ACPI_5_1_LOCAL_APIC_NMI_STRUCTURE;
407		417
408	///	418	///
409	/// Local APIC Address Override Structure	419	/// Local APIC Address Override Structure
410	///	420	///
411	typedef struct {	421	typedef struct {
412	UINT8 Type;	422	UINT8 Type;
413	UINT8 Length;	423	UINT8 Length;
414	UINT16 Reserved;	424	UINT16 Reserved;
415	UINT64 LocalApicAddress;	425	UINT64 LocalApicAddress;
416	} EFI_ACPI_5_1_LOCAL_APIC_ADDRESS_OVERRIDE_STRUCTURE;	426	} EFI_ACPI_5_1_LOCAL_APIC_ADDRESS_OVERRIDE_STRUCTURE;
417		427
418	///	428	///
419	/// IO SAPIC Structure	429	/// IO SAPIC Structure
420	///	430	///
421	typedef struct {	431	typedef struct {
422	UINT8 Type;	432	UINT8 Type;
423	UINT8 Length;	433	UINT8 Length;
424	UINT8 IoApicId;	434	UINT8 IoApicId;
425	UINT8 Reserved;	435	UINT8 Reserved;
426	UINT32 GlobalSystemInterruptBase;	436	UINT32 GlobalSystemInterruptBase;
427	UINT64 IoSapicAddress;	437	UINT64 IoSapicAddress;
428	} EFI_ACPI_5_1_IO_SAPIC_STRUCTURE;	438	} EFI_ACPI_5_1_IO_SAPIC_STRUCTURE;
429		439
430	///	440	///
Lines 432-586 typedef struct { Link Here
432	/// This struct followed by a null-terminated ASCII string - ACPI Processor UID String	442	/// This struct followed by a null-terminated ASCII string - ACPI Processor UID String
433	///	443	///
434	typedef struct {	444	typedef struct {
435	UINT8 Type;	445	UINT8 Type;
436	UINT8 Length;	446	UINT8 Length;
437	UINT8 AcpiProcessorId;	447	UINT8 AcpiProcessorId;
438	UINT8 LocalSapicId;	448	UINT8 LocalSapicId;
439	UINT8 LocalSapicEid;	449	UINT8 LocalSapicEid;
440	UINT8 Reserved[3];	450	UINT8 Reserved[3];
441	UINT32 Flags;	451	UINT32 Flags;
442	UINT32 ACPIProcessorUIDValue;	452	UINT32 ACPIProcessorUIDValue;
443	} EFI_ACPI_5_1_PROCESSOR_LOCAL_SAPIC_STRUCTURE;	453	} EFI_ACPI_5_1_PROCESSOR_LOCAL_SAPIC_STRUCTURE;
444		454
445	///	455	///
446	/// Platform Interrupt Sources Structure	456	/// Platform Interrupt Sources Structure
447	///	457	///
448	typedef struct {	458	typedef struct {
449	UINT8 Type;	459	UINT8 Type;
450	UINT8 Length;	460	UINT8 Length;
451	UINT16 Flags;	461	UINT16 Flags;
452	UINT8 InterruptType;	462	UINT8 InterruptType;
453	UINT8 ProcessorId;	463	UINT8 ProcessorId;
454	UINT8 ProcessorEid;	464	UINT8 ProcessorEid;
455	UINT8 IoSapicVector;	465	UINT8 IoSapicVector;
456	UINT32 GlobalSystemInterrupt;	466	UINT32 GlobalSystemInterrupt;
457	UINT32 PlatformInterruptSourceFlags;	467	UINT32 PlatformInterruptSourceFlags;
458	} EFI_ACPI_5_1_PLATFORM_INTERRUPT_SOURCES_STRUCTURE;	468	} EFI_ACPI_5_1_PLATFORM_INTERRUPT_SOURCES_STRUCTURE;
459		469
460	///	470	///
461	/// Platform Interrupt Source Flags.	471	/// Platform Interrupt Source Flags.
462	/// All other bits are reserved and must be set to 0.	472	/// All other bits are reserved and must be set to 0.
463	///	473	///
464	#define EFI_ACPI_5_1_CPEI_PROCESSOR_OVERRIDE BIT0	474	#define EFI_ACPI_5_1_CPEI_PROCESSOR_OVERRIDE BIT0
465		475
466	///	476	///
467	/// Processor Local x2APIC Structure Definition	477	/// Processor Local x2APIC Structure Definition
468	///	478	///
469	typedef struct {	479	typedef struct {
470	UINT8 Type;	480	UINT8 Type;
471	UINT8 Length;	481	UINT8 Length;
472	UINT8 Reserved[2];	482	UINT8 Reserved[2];
473	UINT32 X2ApicId;	483	UINT32 X2ApicId;
474	UINT32 Flags;	484	UINT32 Flags;
475	UINT32 AcpiProcessorUid;	485	UINT32 AcpiProcessorUid;
476	} EFI_ACPI_5_1_PROCESSOR_LOCAL_X2APIC_STRUCTURE;	486	} EFI_ACPI_5_1_PROCESSOR_LOCAL_X2APIC_STRUCTURE;
477		487
478	///	488	///
479	/// Local x2APIC NMI Structure	489	/// Local x2APIC NMI Structure
480	///	490	///
481	typedef struct {	491	typedef struct {
482	UINT8 Type;	492	UINT8 Type;
483	UINT8 Length;	493	UINT8 Length;
484	UINT16 Flags;	494	UINT16 Flags;
485	UINT32 AcpiProcessorUid;	495	UINT32 AcpiProcessorUid;
486	UINT8 LocalX2ApicLint;	496	UINT8 LocalX2ApicLint;
487	UINT8 Reserved[3];	497	UINT8 Reserved[3];
488	} EFI_ACPI_5_1_LOCAL_X2APIC_NMI_STRUCTURE;	498	} EFI_ACPI_5_1_LOCAL_X2APIC_NMI_STRUCTURE;
489		499
490	///	500	///
491	/// GIC Structure	501	/// GIC Structure
492	///	502	///
493	typedef struct {	503	typedef struct {
494	UINT8 Type;	504	UINT8 Type;
495	UINT8 Length;	505	UINT8 Length;
496	UINT16 Reserved;	506	UINT16 Reserved;
497	UINT32 CPUInterfaceNumber;	507	UINT32 CPUInterfaceNumber;
498	UINT32 AcpiProcessorUid;	508	UINT32 AcpiProcessorUid;
499	UINT32 Flags;	509	UINT32 Flags;
500	UINT32 ParkingProtocolVersion;	510	UINT32 ParkingProtocolVersion;
501	UINT32 PerformanceInterruptGsiv;	511	UINT32 PerformanceInterruptGsiv;
502	UINT64 ParkedAddress;	512	UINT64 ParkedAddress;
503	UINT64 PhysicalBaseAddress;	513	UINT64 PhysicalBaseAddress;
504	UINT64 GICV;	514	UINT64 GICV;
505	UINT64 GICH;	515	UINT64 GICH;
506	UINT32 VGICMaintenanceInterrupt;	516	UINT32 VGICMaintenanceInterrupt;
507	UINT64 GICRBaseAddress;	517	UINT64 GICRBaseAddress;
508	UINT64 MPIDR;	518	UINT64 MPIDR;
509	} EFI_ACPI_5_1_GIC_STRUCTURE;	519	} EFI_ACPI_5_1_GIC_STRUCTURE;
510		520
511	///	521	///
512	/// GIC Flags. All other bits are reserved and must be 0.	522	/// GIC Flags. All other bits are reserved and must be 0.
513	///	523	///
514	#define EFI_ACPI_5_1_GIC_ENABLED BIT0	524	#define EFI_ACPI_5_1_GIC_ENABLED BIT0
515	#define EFI_ACPI_5_1_PERFORMANCE_INTERRUPT_MODEL BIT1	525	#define EFI_ACPI_5_1_PERFORMANCE_INTERRUPT_MODEL BIT1
516	#define EFI_ACPI_5_1_VGIC_MAINTENANCE_INTERRUPT_MODE_FLAGS BIT2	526	#define EFI_ACPI_5_1_VGIC_MAINTENANCE_INTERRUPT_MODE_FLAGS BIT2
517		527
518	///	528	///
519	/// GIC Distributor Structure	529	/// GIC Distributor Structure
520	///	530	///
521	typedef struct {	531	typedef struct {
522	UINT8 Type;	532	UINT8 Type;
523	UINT8 Length;	533	UINT8 Length;
524	UINT16 Reserved1;	534	UINT16 Reserved1;
525	UINT32 GicId;	535	UINT32 GicId;
526	UINT64 PhysicalBaseAddress;	536	UINT64 PhysicalBaseAddress;
527	UINT32 SystemVectorBase;	537	UINT32 SystemVectorBase;
528	UINT8 GicVersion;	538	UINT8 GicVersion;
529	UINT8 Reserved2[3];	539	UINT8 Reserved2[3];
530	} EFI_ACPI_5_1_GIC_DISTRIBUTOR_STRUCTURE;	540	} EFI_ACPI_5_1_GIC_DISTRIBUTOR_STRUCTURE;
531		541
532	///	542	///
533	/// GIC Version	543	/// GIC Version
534	///	544	///
535	#define EFI_ACPI_5_1_GIC_V1 0x01	545	#define EFI_ACPI_5_1_GIC_V1 0x01
536	#define EFI_ACPI_5_1_GIC_V2 0x02	546	#define EFI_ACPI_5_1_GIC_V2 0x02
537	#define EFI_ACPI_5_1_GIC_V3 0x03	547	#define EFI_ACPI_5_1_GIC_V3 0x03
538	#define EFI_ACPI_5_1_GIC_V4 0x04	548	#define EFI_ACPI_5_1_GIC_V4 0x04
539		549
540	///	550	///
541	/// GIC MSI Frame Structure	551	/// GIC MSI Frame Structure
542	///	552	///
543	typedef struct {	553	typedef struct {
544	UINT8 Type;	554	UINT8 Type;
545	UINT8 Length;	555	UINT8 Length;
546	UINT16 Reserved1;	556	UINT16 Reserved1;
547	UINT32 GicMsiFrameId;	557	UINT32 GicMsiFrameId;
548	UINT64 PhysicalBaseAddress;	558	UINT64 PhysicalBaseAddress;
549	UINT32 Flags;	559	UINT32 Flags;
550	UINT16 SPICount;	560	UINT16 SPICount;
551	UINT16 SPIBase;	561	UINT16 SPIBase;
552	} EFI_ACPI_5_1_GIC_MSI_FRAME_STRUCTURE;	562	} EFI_ACPI_5_1_GIC_MSI_FRAME_STRUCTURE;
553		563
554	///	564	///
555	/// GIC MSI Frame Flags. All other bits are reserved and must be 0.	565	/// GIC MSI Frame Flags. All other bits are reserved and must be 0.
556	///	566	///
557	#define EFI_ACPI_5_1_SPI_COUNT_BASE_SELECT BIT0	567	#define EFI_ACPI_5_1_SPI_COUNT_BASE_SELECT BIT0
558		568
559	///	569	///
560	/// GICR Structure	570	/// GICR Structure
561	///	571	///
562	typedef struct {	572	typedef struct {
563	UINT8 Type;	573	UINT8 Type;
564	UINT8 Length;	574	UINT8 Length;
565	UINT16 Reserved;	575	UINT16 Reserved;
566	UINT64 DiscoveryRangeBaseAddress;	576	UINT64 DiscoveryRangeBaseAddress;
567	UINT32 DiscoveryRangeLength;	577	UINT32 DiscoveryRangeLength;
568	} EFI_ACPI_5_1_GICR_STRUCTURE;	578	} EFI_ACPI_5_1_GICR_STRUCTURE;
569		579
570	///	580	///
571	/// Smart Battery Description Table (SBST)	581	/// Smart Battery Description Table (SBST)
572	///	582	///
573	typedef struct {	583	typedef struct {
574	EFI_ACPI_DESCRIPTION_HEADER Header;	584	EFI_ACPI_DESCRIPTION_HEADER Header;
575	UINT32 WarningEnergyLevel;	585	UINT32 WarningEnergyLevel;
576	UINT32 LowEnergyLevel;	586	UINT32 LowEnergyLevel;
577	UINT32 CriticalEnergyLevel;	587	UINT32 CriticalEnergyLevel;
578	} EFI_ACPI_5_1_SMART_BATTERY_DESCRIPTION_TABLE;	588	} EFI_ACPI_5_1_SMART_BATTERY_DESCRIPTION_TABLE;
579		589
580	///	590	///
581	/// SBST Version (as defined in ACPI 5.1 spec.)	591	/// SBST Version (as defined in ACPI 5.1 spec.)
582	///	592	///
583	#define EFI_ACPI_5_1_SMART_BATTERY_DESCRIPTION_TABLE_REVISION 0x01	593	#define EFI_ACPI_5_1_SMART_BATTERY_DESCRIPTION_TABLE_REVISION 0x01
584		594
585	///	595	///
586	/// Embedded Controller Boot Resources Table (ECDT)	596	/// Embedded Controller Boot Resources Table (ECDT)
Lines 588-598 typedef struct { Link Here
588	/// a fully qualified reference to the name space object.	598	/// a fully qualified reference to the name space object.
589	///	599	///
590	typedef struct {	600	typedef struct {
591	EFI_ACPI_DESCRIPTION_HEADER Header;	601	EFI_ACPI_DESCRIPTION_HEADER Header;
592	EFI_ACPI_5_1_GENERIC_ADDRESS_STRUCTURE EcControl;	602	EFI_ACPI_5_1_GENERIC_ADDRESS_STRUCTURE EcControl;
593	EFI_ACPI_5_1_GENERIC_ADDRESS_STRUCTURE EcData;	603	EFI_ACPI_5_1_GENERIC_ADDRESS_STRUCTURE EcData;
594	UINT32 Uid;	604	UINT32 Uid;
595	UINT8 GpeBit;	605	UINT8 GpeBit;
596	} EFI_ACPI_5_1_EMBEDDED_CONTROLLER_BOOT_RESOURCES_TABLE;	606	} EFI_ACPI_5_1_EMBEDDED_CONTROLLER_BOOT_RESOURCES_TABLE;
597		607
598	///	608	///
Lines 605-613 typedef struct { Link Here
605	/// must be defined in a platform specific manner.	615	/// must be defined in a platform specific manner.
606	///	616	///
607	typedef struct {	617	typedef struct {
608	EFI_ACPI_DESCRIPTION_HEADER Header;	618	EFI_ACPI_DESCRIPTION_HEADER Header;
609	UINT32 Reserved1; ///< Must be set to 1	619	UINT32 Reserved1; ///< Must be set to 1
610	UINT64 Reserved2;	620	UINT64 Reserved2;
611	} EFI_ACPI_5_1_SYSTEM_RESOURCE_AFFINITY_TABLE_HEADER;	621	} EFI_ACPI_5_1_SYSTEM_RESOURCE_AFFINITY_TABLE_HEADER;
612		622
613	///	623	///
Lines 629-711 typedef struct { Link Here
629	/// Processor Local APIC/SAPIC Affinity Structure Definition	639	/// Processor Local APIC/SAPIC Affinity Structure Definition
630	///	640	///
631	typedef struct {	641	typedef struct {
632	UINT8 Type;	642	UINT8 Type;
633	UINT8 Length;	643	UINT8 Length;
634	UINT8 ProximityDomain7To0;	644	UINT8 ProximityDomain7To0;
635	UINT8 ApicId;	645	UINT8 ApicId;
636	UINT32 Flags;	646	UINT32 Flags;
637	UINT8 LocalSapicEid;	647	UINT8 LocalSapicEid;
638	UINT8 ProximityDomain31To8[3];	648	UINT8 ProximityDomain31To8[3];
639	UINT32 ClockDomain;	649	UINT32 ClockDomain;
640	} EFI_ACPI_5_1_PROCESSOR_LOCAL_APIC_SAPIC_AFFINITY_STRUCTURE;	650	} EFI_ACPI_5_1_PROCESSOR_LOCAL_APIC_SAPIC_AFFINITY_STRUCTURE;
641		651
642	///	652	///
643	/// Local APIC/SAPIC Flags. All other bits are reserved and must be 0.	653	/// Local APIC/SAPIC Flags. All other bits are reserved and must be 0.
644	///	654	///
645	#define EFI_ACPI_5_1_PROCESSOR_LOCAL_APIC_SAPIC_ENABLED (1 << 0)	655	#define EFI_ACPI_5_1_PROCESSOR_LOCAL_APIC_SAPIC_ENABLED (1 << 0)
646		656
647	///	657	///
648	/// Memory Affinity Structure Definition	658	/// Memory Affinity Structure Definition
649	///	659	///
650	typedef struct {	660	typedef struct {
651	UINT8 Type;	661	UINT8 Type;
652	UINT8 Length;	662	UINT8 Length;
653	UINT32 ProximityDomain;	663	UINT32 ProximityDomain;
654	UINT16 Reserved1;	664	UINT16 Reserved1;
655	UINT32 AddressBaseLow;	665	UINT32 AddressBaseLow;
656	UINT32 AddressBaseHigh;	666	UINT32 AddressBaseHigh;
657	UINT32 LengthLow;	667	UINT32 LengthLow;
658	UINT32 LengthHigh;	668	UINT32 LengthHigh;
659	UINT32 Reserved2;	669	UINT32 Reserved2;
660	UINT32 Flags;	670	UINT32 Flags;
661	UINT64 Reserved3;	671	UINT64 Reserved3;
662	} EFI_ACPI_5_1_MEMORY_AFFINITY_STRUCTURE;	672	} EFI_ACPI_5_1_MEMORY_AFFINITY_STRUCTURE;
663		673
664	//	674	//
665	// Memory Flags. All other bits are reserved and must be 0.	675	// Memory Flags. All other bits are reserved and must be 0.
666	//	676	//
667	#define EFI_ACPI_5_1_MEMORY_ENABLED (1 << 0)	677	#define EFI_ACPI_5_1_MEMORY_ENABLED (1 << 0)
668	#define EFI_ACPI_5_1_MEMORY_HOT_PLUGGABLE (1 << 1)	678	#define EFI_ACPI_5_1_MEMORY_HOT_PLUGGABLE (1 << 1)
669	#define EFI_ACPI_5_1_MEMORY_NONVOLATILE (1 << 2)	679	#define EFI_ACPI_5_1_MEMORY_NONVOLATILE (1 << 2)
670		680
671	///	681	///
672	/// Processor Local x2APIC Affinity Structure Definition	682	/// Processor Local x2APIC Affinity Structure Definition
673	///	683	///
674	typedef struct {	684	typedef struct {
675	UINT8 Type;	685	UINT8 Type;
676	UINT8 Length;	686	UINT8 Length;
677	UINT8 Reserved1[2];	687	UINT8 Reserved1[2];
678	UINT32 ProximityDomain;	688	UINT32 ProximityDomain;
679	UINT32 X2ApicId;	689	UINT32 X2ApicId;
680	UINT32 Flags;	690	UINT32 Flags;
681	UINT32 ClockDomain;	691	UINT32 ClockDomain;
682	UINT8 Reserved2[4];	692	UINT8 Reserved2[4];
683	} EFI_ACPI_5_1_PROCESSOR_LOCAL_X2APIC_AFFINITY_STRUCTURE;	693	} EFI_ACPI_5_1_PROCESSOR_LOCAL_X2APIC_AFFINITY_STRUCTURE;
684		694
685	///	695	///
686	/// GICC Affinity Structure Definition	696	/// GICC Affinity Structure Definition
687	///	697	///
688	typedef struct {	698	typedef struct {
689	UINT8 Type;	699	UINT8 Type;
690	UINT8 Length;	700	UINT8 Length;
691	UINT32 ProximityDomain;	701	UINT32 ProximityDomain;
692	UINT32 AcpiProcessorUid;	702	UINT32 AcpiProcessorUid;
693	UINT32 Flags;	703	UINT32 Flags;
694	UINT32 ClockDomain;	704	UINT32 ClockDomain;
695	} EFI_ACPI_5_1_GICC_AFFINITY_STRUCTURE;	705	} EFI_ACPI_5_1_GICC_AFFINITY_STRUCTURE;
696		706
697	///	707	///
698	/// GICC Flags. All other bits are reserved and must be 0.	708	/// GICC Flags. All other bits are reserved and must be 0.
699	///	709	///
700	#define EFI_ACPI_5_1_GICC_ENABLED (1 << 0)	710	#define EFI_ACPI_5_1_GICC_ENABLED (1 << 0)
701		711
702	///	712	///
703	/// System Locality Distance Information Table (SLIT).	713	/// System Locality Distance Information Table (SLIT).
704	/// The rest of the table is a matrix.	714	/// The rest of the table is a matrix.
705	///	715	///
706	typedef struct {	716	typedef struct {
707	EFI_ACPI_DESCRIPTION_HEADER Header;	717	EFI_ACPI_DESCRIPTION_HEADER Header;
708	UINT64 NumberOfSystemLocalities;	718	UINT64 NumberOfSystemLocalities;
709	} EFI_ACPI_5_1_SYSTEM_LOCALITY_DISTANCE_INFORMATION_TABLE_HEADER;	719	} EFI_ACPI_5_1_SYSTEM_LOCALITY_DISTANCE_INFORMATION_TABLE_HEADER;
710		720
711	///	721	///
Lines 717-730 typedef struct { Link Here
717	/// Corrected Platform Error Polling Table (CPEP)	727	/// Corrected Platform Error Polling Table (CPEP)
718	///	728	///
719	typedef struct {	729	typedef struct {
720	EFI_ACPI_DESCRIPTION_HEADER Header;	730	EFI_ACPI_DESCRIPTION_HEADER Header;
721	UINT8 Reserved[8];	731	UINT8 Reserved[8];
722	} EFI_ACPI_5_1_CORRECTED_PLATFORM_ERROR_POLLING_TABLE_HEADER;	732	} EFI_ACPI_5_1_CORRECTED_PLATFORM_ERROR_POLLING_TABLE_HEADER;
723		733
724	///	734	///
725	/// CPEP Version (as defined in ACPI 5.1 spec.)	735	/// CPEP Version (as defined in ACPI 5.1 spec.)
726	///	736	///
727	#define EFI_ACPI_5_1_CORRECTED_PLATFORM_ERROR_POLLING_TABLE_REVISION 0x01	737	#define EFI_ACPI_5_1_CORRECTED_PLATFORM_ERROR_POLLING_TABLE_REVISION 0x01
728		738
729	//	739	//
730	// CPEP processor structure types.	740	// CPEP processor structure types.
Lines 735-800 typedef struct { Link Here
735	/// Corrected Platform Error Polling Processor Structure Definition	745	/// Corrected Platform Error Polling Processor Structure Definition
736	///	746	///
737	typedef struct {	747	typedef struct {
738	UINT8 Type;	748	UINT8 Type;
739	UINT8 Length;	749	UINT8 Length;
740	UINT8 ProcessorId;	750	UINT8 ProcessorId;
741	UINT8 ProcessorEid;	751	UINT8 ProcessorEid;
742	UINT32 PollingInterval;	752	UINT32 PollingInterval;
743	} EFI_ACPI_5_1_CPEP_PROCESSOR_APIC_SAPIC_STRUCTURE;	753	} EFI_ACPI_5_1_CPEP_PROCESSOR_APIC_SAPIC_STRUCTURE;
744		754
745	///	755	///
746	/// Maximum System Characteristics Table (MSCT)	756	/// Maximum System Characteristics Table (MSCT)
747	///	757	///
748	typedef struct {	758	typedef struct {
749	EFI_ACPI_DESCRIPTION_HEADER Header;	759	EFI_ACPI_DESCRIPTION_HEADER Header;
750	UINT32 OffsetProxDomInfo;	760	UINT32 OffsetProxDomInfo;
751	UINT32 MaximumNumberOfProximityDomains;	761	UINT32 MaximumNumberOfProximityDomains;
752	UINT32 MaximumNumberOfClockDomains;	762	UINT32 MaximumNumberOfClockDomains;
753	UINT64 MaximumPhysicalAddress;	763	UINT64 MaximumPhysicalAddress;
754	} EFI_ACPI_5_1_MAXIMUM_SYSTEM_CHARACTERISTICS_TABLE_HEADER;	764	} EFI_ACPI_5_1_MAXIMUM_SYSTEM_CHARACTERISTICS_TABLE_HEADER;
755		765
756	///	766	///
757	/// MSCT Version (as defined in ACPI 5.1 spec.)	767	/// MSCT Version (as defined in ACPI 5.1 spec.)
758	///	768	///
759	#define EFI_ACPI_5_1_MAXIMUM_SYSTEM_CHARACTERISTICS_TABLE_REVISION 0x01	769	#define EFI_ACPI_5_1_MAXIMUM_SYSTEM_CHARACTERISTICS_TABLE_REVISION 0x01
760		770
761	///	771	///
762	/// Maximum Proximity Domain Information Structure Definition	772	/// Maximum Proximity Domain Information Structure Definition
763	///	773	///
764	typedef struct {	774	typedef struct {
765	UINT8 Revision;	775	UINT8 Revision;
766	UINT8 Length;	776	UINT8 Length;
767	UINT32 ProximityDomainRangeLow;	777	UINT32 ProximityDomainRangeLow;
768	UINT32 ProximityDomainRangeHigh;	778	UINT32 ProximityDomainRangeHigh;
769	UINT32 MaximumProcessorCapacity;	779	UINT32 MaximumProcessorCapacity;
770	UINT64 MaximumMemoryCapacity;	780	UINT64 MaximumMemoryCapacity;
771	} EFI_ACPI_5_1_MAXIMUM_PROXIMITY_DOMAIN_INFORMATION_STRUCTURE;	781	} EFI_ACPI_5_1_MAXIMUM_PROXIMITY_DOMAIN_INFORMATION_STRUCTURE;
772		782
773	///	783	///
774	/// ACPI RAS Feature Table definition.	784	/// ACPI RAS Feature Table definition.
775	///	785	///
776	typedef struct {	786	typedef struct {
777	EFI_ACPI_DESCRIPTION_HEADER Header;	787	EFI_ACPI_DESCRIPTION_HEADER Header;
778	UINT8 PlatformCommunicationChannelIdentifier[12];	788	UINT8 PlatformCommunicationChannelIdentifier[12];
779	} EFI_ACPI_5_1_RAS_FEATURE_TABLE;	789	} EFI_ACPI_5_1_RAS_FEATURE_TABLE;
780		790
781	///	791	///
782	/// RASF Version (as defined in ACPI 5.1 spec.)	792	/// RASF Version (as defined in ACPI 5.1 spec.)
783	///	793	///
784	#define EFI_ACPI_5_1_RAS_FEATURE_TABLE_REVISION 0x01	794	#define EFI_ACPI_5_1_RAS_FEATURE_TABLE_REVISION 0x01
785		795
786	///	796	///
787	/// ACPI RASF Platform Communication Channel Shared Memory Region definition.	797	/// ACPI RASF Platform Communication Channel Shared Memory Region definition.
788	///	798	///
789	typedef struct {	799	typedef struct {
790	UINT32 Signature;	800	UINT32 Signature;
791	UINT16 Command;	801	UINT16 Command;
792	UINT16 Status;	802	UINT16 Status;
793	UINT16 Version;	803	UINT16 Version;
794	UINT8 RASCapabilities[16];	804	UINT8 RASCapabilities[16];
795	UINT8 SetRASCapabilities[16];	805	UINT8 SetRASCapabilities[16];
796	UINT16 NumberOfRASFParameterBlocks;	806	UINT16 NumberOfRASFParameterBlocks;
797	UINT32 SetRASCapabilitiesStatus;	807	UINT32 SetRASCapabilitiesStatus;
798	} EFI_ACPI_5_1_RASF_PLATFORM_COMMUNICATION_CHANNEL_SHARED_MEMORY_REGION;	808	} EFI_ACPI_5_1_RASF_PLATFORM_COMMUNICATION_CHANNEL_SHARED_MEMORY_REGION;
799		809
800	///	810	///
Lines 812-863 typedef struct { Link Here
812	/// ACPI RASF Parameter Block structure for PATROL_SCRUB	822	/// ACPI RASF Parameter Block structure for PATROL_SCRUB
813	///	823	///
814	typedef struct {	824	typedef struct {
815	UINT16 Type;	825	UINT16 Type;
816	UINT16 Version;	826	UINT16 Version;
817	UINT16 Length;	827	UINT16 Length;
818	UINT16 PatrolScrubCommand;	828	UINT16 PatrolScrubCommand;
819	UINT64 RequestedAddressRange[2];	829	UINT64 RequestedAddressRange[2];
820	UINT64 ActualAddressRange[2];	830	UINT64 ActualAddressRange[2];
821	UINT16 Flags;	831	UINT16 Flags;
822	UINT8 RequestedSpeed;	832	UINT8 RequestedSpeed;
823	} EFI_ACPI_5_1_RASF_PATROL_SCRUB_PLATFORM_BLOCK_STRUCTURE;	833	} EFI_ACPI_5_1_RASF_PATROL_SCRUB_PLATFORM_BLOCK_STRUCTURE;
824		834
825	///	835	///
826	/// ACPI RASF Patrol Scrub command	836	/// ACPI RASF Patrol Scrub command
827	///	837	///
828	#define EFI_ACPI_5_1_RASF_PATROL_SCRUB_COMMAND_GET_PATROL_PARAMETERS 0x01	838	#define EFI_ACPI_5_1_RASF_PATROL_SCRUB_COMMAND_GET_PATROL_PARAMETERS 0x01
829	#define EFI_ACPI_5_1_RASF_PATROL_SCRUB_COMMAND_START_PATROL_SCRUBBER 0x02	839	#define EFI_ACPI_5_1_RASF_PATROL_SCRUB_COMMAND_START_PATROL_SCRUBBER 0x02
830	#define EFI_ACPI_5_1_RASF_PATROL_SCRUB_COMMAND_STOP_PATROL_SCRUBBER 0x03	840	#define EFI_ACPI_5_1_RASF_PATROL_SCRUB_COMMAND_STOP_PATROL_SCRUBBER 0x03
831		841
832	///	842	///
833	/// Memory Power State Table definition.	843	/// Memory Power State Table definition.
834	///	844	///
835	typedef struct {	845	typedef struct {
836	EFI_ACPI_DESCRIPTION_HEADER Header;	846	EFI_ACPI_DESCRIPTION_HEADER Header;
837	UINT8 PlatformCommunicationChannelIdentifier;	847	UINT8 PlatformCommunicationChannelIdentifier;
838	UINT8 Reserved[3];	848	UINT8 Reserved[3];
839	// Memory Power Node Structure	849	// Memory Power Node Structure
840	// Memory Power State Characteristics	850	// Memory Power State Characteristics
841	} EFI_ACPI_5_1_MEMORY_POWER_STATUS_TABLE;	851	} EFI_ACPI_5_1_MEMORY_POWER_STATUS_TABLE;
842		852
843	///	853	///
844	/// MPST Version (as defined in ACPI 5.1 spec.)	854	/// MPST Version (as defined in ACPI 5.1 spec.)
845	///	855	///
846	#define EFI_ACPI_5_1_MEMORY_POWER_STATE_TABLE_REVISION 0x01	856	#define EFI_ACPI_5_1_MEMORY_POWER_STATE_TABLE_REVISION 0x01
847		857
848	///	858	///
849	/// MPST Platform Communication Channel Shared Memory Region definition.	859	/// MPST Platform Communication Channel Shared Memory Region definition.
850	///	860	///
851	typedef struct {	861	typedef struct {
852	UINT32 Signature;	862	UINT32 Signature;
853	UINT16 Command;	863	UINT16 Command;
854	UINT16 Status;	864	UINT16 Status;
855	UINT32 MemoryPowerCommandRegister;	865	UINT32 MemoryPowerCommandRegister;
856	UINT32 MemoryPowerStatusRegister;	866	UINT32 MemoryPowerStatusRegister;
857	UINT32 PowerStateId;	867	UINT32 PowerStateId;
858	UINT32 MemoryPowerNodeId;	868	UINT32 MemoryPowerNodeId;
859	UINT64 MemoryEnergyConsumed;	869	UINT64 MemoryEnergyConsumed;
860	UINT64 ExpectedAveragePowerComsuned;	870	UINT64 ExpectedAveragePowerComsuned;
861	} EFI_ACPI_5_1_MPST_PLATFORM_COMMUNICATION_CHANNEL_SHARED_MEMORY_REGION;	871	} EFI_ACPI_5_1_MPST_PLATFORM_COMMUNICATION_CHANNEL_SHARED_MEMORY_REGION;
862		872
863	///	873	///
Lines 868-1053 typedef struct { Link Here
868	///	878	///
869	/// ACPI MPST Memory Power command	879	/// ACPI MPST Memory Power command
870	///	880	///
871	#define EFI_ACPI_5_1_MPST_MEMORY_POWER_COMMAND_GET_MEMORY_POWER_STATE 0x01	881	#define EFI_ACPI_5_1_MPST_MEMORY_POWER_COMMAND_GET_MEMORY_POWER_STATE 0x01
872	#define EFI_ACPI_5_1_MPST_MEMORY_POWER_COMMAND_SET_MEMORY_POWER_STATE 0x02	882	#define EFI_ACPI_5_1_MPST_MEMORY_POWER_COMMAND_SET_MEMORY_POWER_STATE 0x02
873	#define EFI_ACPI_5_1_MPST_MEMORY_POWER_COMMAND_GET_AVERAGE_POWER_CONSUMED 0x03	883	#define EFI_ACPI_5_1_MPST_MEMORY_POWER_COMMAND_GET_AVERAGE_POWER_CONSUMED 0x03
874	#define EFI_ACPI_5_1_MPST_MEMORY_POWER_COMMAND_GET_MEMORY_ENERGY_CONSUMED 0x04	884	#define EFI_ACPI_5_1_MPST_MEMORY_POWER_COMMAND_GET_MEMORY_ENERGY_CONSUMED 0x04
875		885
876	///	886	///
877	/// MPST Memory Power Node Table	887	/// MPST Memory Power Node Table
878	///	888	///
879	typedef struct {	889	typedef struct {
880	UINT8 PowerStateValue;	890	UINT8 PowerStateValue;
881	UINT8 PowerStateInformationIndex;	891	UINT8 PowerStateInformationIndex;
882	} EFI_ACPI_5_1_MPST_MEMORY_POWER_STATE;	892	} EFI_ACPI_5_1_MPST_MEMORY_POWER_STATE;
883		893
884	typedef struct {	894	typedef struct {
885	UINT8 Flag;	895	UINT8 Flag;
886	UINT8 Reserved;	896	UINT8 Reserved;
887	UINT16 MemoryPowerNodeId;	897	UINT16 MemoryPowerNodeId;
888	UINT32 Length;	898	UINT32 Length;
889	UINT64 AddressBase;	899	UINT64 AddressBase;
890	UINT64 AddressLength;	900	UINT64 AddressLength;
891	UINT32 NumberOfPowerStates;	901	UINT32 NumberOfPowerStates;
892	UINT32 NumberOfPhysicalComponents;	902	UINT32 NumberOfPhysicalComponents;
893	//EFI_ACPI_5_1_MPST_MEMORY_POWER_STATE MemoryPowerState[NumberOfPowerStates];	903	// EFI_ACPI_5_1_MPST_MEMORY_POWER_STATE MemoryPowerState[NumberOfPowerStates];
894	//UINT16 PhysicalComponentIdentifier[NumberOfPhysicalComponents];	904	// UINT16 PhysicalComponentIdentifier[NumberOfPhysicalComponents];
895	} EFI_ACPI_5_1_MPST_MEMORY_POWER_STRUCTURE;	905	} EFI_ACPI_5_1_MPST_MEMORY_POWER_STRUCTURE;
896		906
897	#define EFI_ACPI_5_1_MPST_MEMORY_POWER_STRUCTURE_FLAG_ENABLE 0x01	907	#define EFI_ACPI_5_1_MPST_MEMORY_POWER_STRUCTURE_FLAG_ENABLE 0x01
898	#define EFI_ACPI_5_1_MPST_MEMORY_POWER_STRUCTURE_FLAG_POWER_MANAGED 0x02	908	#define EFI_ACPI_5_1_MPST_MEMORY_POWER_STRUCTURE_FLAG_POWER_MANAGED 0x02
899	#define EFI_ACPI_5_1_MPST_MEMORY_POWER_STRUCTURE_FLAG_HOT_PLUGGABLE 0x04	909	#define EFI_ACPI_5_1_MPST_MEMORY_POWER_STRUCTURE_FLAG_HOT_PLUGGABLE 0x04
900		910
901	typedef struct {	911	typedef struct {
902	UINT16 MemoryPowerNodeCount;	912	UINT16 MemoryPowerNodeCount;
903	UINT8 Reserved[2];	913	UINT8 Reserved[2];
904	} EFI_ACPI_5_1_MPST_MEMORY_POWER_NODE_TABLE;	914	} EFI_ACPI_5_1_MPST_MEMORY_POWER_NODE_TABLE;
905		915
906	///	916	///
907	/// MPST Memory Power State Characteristics Table	917	/// MPST Memory Power State Characteristics Table
908	///	918	///
909	typedef struct {	919	typedef struct {
910	UINT8 PowerStateStructureID;	920	UINT8 PowerStateStructureID;
911	UINT8 Flag;	921	UINT8 Flag;
912	UINT16 Reserved;	922	UINT16 Reserved;
913	UINT32 AveragePowerConsumedInMPS0;	923	UINT32 AveragePowerConsumedInMPS0;
914	UINT32 RelativePowerSavingToMPS0;	924	UINT32 RelativePowerSavingToMPS0;
915	UINT64 ExitLatencyToMPS0;	925	UINT64 ExitLatencyToMPS0;
916	} EFI_ACPI_5_1_MPST_MEMORY_POWER_STATE_CHARACTERISTICS_STRUCTURE;	926	} EFI_ACPI_5_1_MPST_MEMORY_POWER_STATE_CHARACTERISTICS_STRUCTURE;
917		927
918	#define EFI_ACPI_5_1_MPST_MEMORY_POWER_STATE_CHARACTERISTICS_STRUCTURE_FLAG_MEMORY_CONTENT_PRESERVED 0x01	928	#define EFI_ACPI_5_1_MPST_MEMORY_POWER_STATE_CHARACTERISTICS_STRUCTURE_FLAG_MEMORY_CONTENT_PRESERVED 0x01
919	#define EFI_ACPI_5_1_MPST_MEMORY_POWER_STATE_CHARACTERISTICS_STRUCTURE_FLAG_AUTONOMOUS_MEMORY_POWER_STATE_ENTRY 0x02	929	#define EFI_ACPI_5_1_MPST_MEMORY_POWER_STATE_CHARACTERISTICS_STRUCTURE_FLAG_AUTONOMOUS_MEMORY_POWER_STATE_ENTRY 0x02
920	#define EFI_ACPI_5_1_MPST_MEMORY_POWER_STATE_CHARACTERISTICS_STRUCTURE_FLAG_AUTONOMOUS_MEMORY_POWER_STATE_EXIT 0x04	930	#define EFI_ACPI_5_1_MPST_MEMORY_POWER_STATE_CHARACTERISTICS_STRUCTURE_FLAG_AUTONOMOUS_MEMORY_POWER_STATE_EXIT 0x04
921		931
922	typedef struct {	932	typedef struct {
923	UINT16 MemoryPowerStateCharacteristicsCount;	933	UINT16 MemoryPowerStateCharacteristicsCount;
924	UINT8 Reserved[2];	934	UINT8 Reserved[2];
925	} EFI_ACPI_5_1_MPST_MEMORY_POWER_STATE_CHARACTERISTICS_TABLE;	935	} EFI_ACPI_5_1_MPST_MEMORY_POWER_STATE_CHARACTERISTICS_TABLE;
926		936
927	///	937	///
928	/// Memory Topology Table definition.	938	/// Memory Topology Table definition.
929	///	939	///
930	typedef struct {	940	typedef struct {
931	EFI_ACPI_DESCRIPTION_HEADER Header;	941	EFI_ACPI_DESCRIPTION_HEADER Header;
932	UINT32 Reserved;	942	UINT32 Reserved;
933	} EFI_ACPI_5_1_MEMORY_TOPOLOGY_TABLE;	943	} EFI_ACPI_5_1_MEMORY_TOPOLOGY_TABLE;
934		944
935	///	945	///
936	/// PMTT Version (as defined in ACPI 5.1 spec.)	946	/// PMTT Version (as defined in ACPI 5.1 spec.)
937	///	947	///
938	#define EFI_ACPI_5_1_MEMORY_TOPOLOGY_TABLE_REVISION 0x01	948	#define EFI_ACPI_5_1_MEMORY_TOPOLOGY_TABLE_REVISION 0x01
939		949
940	///	950	///
941	/// Common Memory Aggregator Device Structure.	951	/// Common Memory Aggregator Device Structure.
942	///	952	///
943	typedef struct {	953	typedef struct {
944	UINT8 Type;	954	UINT8 Type;
945	UINT8 Reserved;	955	UINT8 Reserved;
946	UINT16 Length;	956	UINT16 Length;
947	UINT16 Flags;	957	UINT16 Flags;
948	UINT16 Reserved1;	958	UINT16 Reserved1;
949	} EFI_ACPI_5_1_PMMT_COMMON_MEMORY_AGGREGATOR_DEVICE_STRUCTURE;	959	} EFI_ACPI_5_1_PMMT_COMMON_MEMORY_AGGREGATOR_DEVICE_STRUCTURE;
950		960
951	///	961	///
952	/// Memory Aggregator Device Type	962	/// Memory Aggregator Device Type
953	///	963	///
954	#define EFI_ACPI_5_1_PMMT_MEMORY_AGGREGATOR_DEVICE_TYPE_SOCKET 0x1	964	#define EFI_ACPI_5_1_PMMT_MEMORY_AGGREGATOR_DEVICE_TYPE_SOCKET 0x0
955	#define EFI_ACPI_5_1_PMMT_MEMORY_AGGREGATOR_DEVICE_TYPE_MEMORY_CONTROLLER 0x2	965	#define EFI_ACPI_5_1_PMMT_MEMORY_AGGREGATOR_DEVICE_TYPE_MEMORY_CONTROLLER 0x1
956	#define EFI_ACPI_5_1_PMMT_MEMORY_AGGREGATOR_DEVICE_TYPE_DIMM 0x3	966	#define EFI_ACPI_5_1_PMMT_MEMORY_AGGREGATOR_DEVICE_TYPE_DIMM 0x2
957		967
958	///	968	///
959	/// Socket Memory Aggregator Device Structure.	969	/// Socket Memory Aggregator Device Structure.
960	///	970	///
961	typedef struct {	971	typedef struct {
962	EFI_ACPI_5_1_PMMT_COMMON_MEMORY_AGGREGATOR_DEVICE_STRUCTURE Header;	972	EFI_ACPI_5_1_PMMT_COMMON_MEMORY_AGGREGATOR_DEVICE_STRUCTURE Header;
963	UINT16 SocketIdentifier;	973	UINT16 SocketIdentifier;
964	UINT16 Reserved;	974	UINT16 Reserved;
965	//EFI_ACPI_5_1_PMMT_MEMORY_CONTROLLER_MEMORY_AGGREGATOR_DEVICE_STRUCTURE MemoryController[];	975	// EFI_ACPI_5_1_PMMT_MEMORY_CONTROLLER_MEMORY_AGGREGATOR_DEVICE_STRUCTURE MemoryController[];
966	} EFI_ACPI_5_1_PMMT_SOCKET_MEMORY_AGGREGATOR_DEVICE_STRUCTURE;	976	} EFI_ACPI_5_1_PMMT_SOCKET_MEMORY_AGGREGATOR_DEVICE_STRUCTURE;
967		977
968	///	978	///
969	/// MemoryController Memory Aggregator Device Structure.	979	/// MemoryController Memory Aggregator Device Structure.
970	///	980	///
971	typedef struct {	981	typedef struct {
972	EFI_ACPI_5_1_PMMT_COMMON_MEMORY_AGGREGATOR_DEVICE_STRUCTURE Header;	982	EFI_ACPI_5_1_PMMT_COMMON_MEMORY_AGGREGATOR_DEVICE_STRUCTURE Header;
973	UINT32 ReadLatency;	983	UINT32 ReadLatency;
974	UINT32 WriteLatency;	984	UINT32 WriteLatency;
975	UINT32 ReadBandwidth;	985	UINT32 ReadBandwidth;
976	UINT32 WriteBandwidth;	986	UINT32 WriteBandwidth;
977	UINT16 OptimalAccessUnit;	987	UINT16 OptimalAccessUnit;
978	UINT16 OptimalAccessAlignment;	988	UINT16 OptimalAccessAlignment;
979	UINT16 Reserved;	989	UINT16 Reserved;
980	UINT16 NumberOfProximityDomains;	990	UINT16 NumberOfProximityDomains;
981	//UINT32 ProximityDomain[NumberOfProximityDomains];	991	// UINT32 ProximityDomain[NumberOfProximityDomains];
982	//EFI_ACPI_5_1_PMMT_DIMM_MEMORY_AGGREGATOR_DEVICE_STRUCTURE PhysicalComponent[];	992	// EFI_ACPI_5_1_PMMT_DIMM_MEMORY_AGGREGATOR_DEVICE_STRUCTURE PhysicalComponent[];
983	} EFI_ACPI_5_1_PMMT_MEMORY_CONTROLLER_MEMORY_AGGREGATOR_DEVICE_STRUCTURE;	993	} EFI_ACPI_5_1_PMMT_MEMORY_CONTROLLER_MEMORY_AGGREGATOR_DEVICE_STRUCTURE;
984		994
985	///	995	///
986	/// DIMM Memory Aggregator Device Structure.	996	/// DIMM Memory Aggregator Device Structure.
987	///	997	///
988	typedef struct {	998	typedef struct {
989	EFI_ACPI_5_1_PMMT_COMMON_MEMORY_AGGREGATOR_DEVICE_STRUCTURE Header;	999	EFI_ACPI_5_1_PMMT_COMMON_MEMORY_AGGREGATOR_DEVICE_STRUCTURE Header;
990	UINT16 PhysicalComponentIdentifier;	1000	UINT16 PhysicalComponentIdentifier;
991	UINT16 Reserved;	1001	UINT16 Reserved;
992	UINT32 SizeOfDimm;	1002	UINT32 SizeOfDimm;
993	UINT32 SmbiosHandle;	1003	UINT32 SmbiosHandle;
994	} EFI_ACPI_5_1_PMMT_DIMM_MEMORY_AGGREGATOR_DEVICE_STRUCTURE;	1004	} EFI_ACPI_5_1_PMMT_DIMM_MEMORY_AGGREGATOR_DEVICE_STRUCTURE;
995		1005
996	///	1006	///
997	/// Boot Graphics Resource Table definition.	1007	/// Boot Graphics Resource Table definition.
998	///	1008	///
999	typedef struct {	1009	typedef struct {
1000	EFI_ACPI_DESCRIPTION_HEADER Header;	1010	EFI_ACPI_DESCRIPTION_HEADER Header;
1001	///	1011	///
1002	/// 2-bytes (16 bit) version ID. This value must be 1.	1012	/// 2-bytes (16 bit) version ID. This value must be 1.
1003	///	1013	///
1004	UINT16 Version;	1014	UINT16 Version;
1005	///	1015	///
1006	/// 1-byte status field indicating current status about the table.	1016	/// 1-byte status field indicating current status about the table.
1007	/// Bits[7:1] = Reserved (must be zero)	1017	/// Bits[7:1] = Reserved (must be zero)
1008	/// Bit [0] = Valid. A one indicates the boot image graphic is valid.	1018	/// Bit [0] = Valid. A one indicates the boot image graphic is valid.
1009	///	1019	///
1010	UINT8 Status;	1020	UINT8 Status;
1011	///	1021	///
1012	/// 1-byte enumerated type field indicating format of the image.	1022	/// 1-byte enumerated type field indicating format of the image.
1013	/// 0 = Bitmap	1023	/// 0 = Bitmap
1014	/// 1 - 255 Reserved (for future use)	1024	/// 1 - 255 Reserved (for future use)
1015	///	1025	///
1016	UINT8 ImageType;	1026	UINT8 ImageType;
1017	///	1027	///
1018	/// 8-byte (64 bit) physical address pointing to the firmware's in-memory copy	1028	/// 8-byte (64 bit) physical address pointing to the firmware's in-memory copy
1019	/// of the image bitmap.	1029	/// of the image bitmap.
1020	///	1030	///
1021	UINT64 ImageAddress;	1031	UINT64 ImageAddress;
1022	///	1032	///
1023	/// A 4-byte (32-bit) unsigned long describing the display X-offset of the boot image.	1033	/// A 4-byte (32-bit) unsigned long describing the display X-offset of the boot image.
1024	/// (X, Y) display offset of the top left corner of the boot image.	1034	/// (X, Y) display offset of the top left corner of the boot image.
1025	/// The top left corner of the display is at offset (0, 0).	1035	/// The top left corner of the display is at offset (0, 0).
1026	///	1036	///
1027	UINT32 ImageOffsetX;	1037	UINT32 ImageOffsetX;
1028	///	1038	///
1029	/// A 4-byte (32-bit) unsigned long describing the display Y-offset of the boot image.	1039	/// A 4-byte (32-bit) unsigned long describing the display Y-offset of the boot image.
1030	/// (X, Y) display offset of the top left corner of the boot image.	1040	/// (X, Y) display offset of the top left corner of the boot image.
1031	/// The top left corner of the display is at offset (0, 0).	1041	/// The top left corner of the display is at offset (0, 0).
1032	///	1042	///
1033	UINT32 ImageOffsetY;	1043	UINT32 ImageOffsetY;
1034	} EFI_ACPI_5_1_BOOT_GRAPHICS_RESOURCE_TABLE;	1044	} EFI_ACPI_5_1_BOOT_GRAPHICS_RESOURCE_TABLE;
1035		1045
1036	///	1046	///
1037	/// BGRT Revision	1047	/// BGRT Revision
1038	///	1048	///
1039	#define EFI_ACPI_5_1_BOOT_GRAPHICS_RESOURCE_TABLE_REVISION 1	1049	#define EFI_ACPI_5_1_BOOT_GRAPHICS_RESOURCE_TABLE_REVISION 1
1040		1050
1041	///	1051	///
1042	/// BGRT Version	1052	/// BGRT Version
1043	///	1053	///
1044	#define EFI_ACPI_5_1_BGRT_VERSION 0x01	1054	#define EFI_ACPI_5_1_BGRT_VERSION 0x01
1045		1055
1046	///	1056	///
1047	/// BGRT Status	1057	/// BGRT Status
1048	///	1058	///
1049	#define EFI_ACPI_5_1_BGRT_STATUS_NOT_DISPLAYED 0x00	1059	#define EFI_ACPI_5_1_BGRT_STATUS_NOT_DISPLAYED 0x00
1050	#define EFI_ACPI_5_1_BGRT_STATUS_DISPLAYED 0x01	1060	#define EFI_ACPI_5_1_BGRT_STATUS_DISPLAYED 0x01
1051		1061
1052	///	1062	///
1053	/// BGRT Image Type	1063	/// BGRT Image Type
Lines 1057-1082 typedef struct { Link Here
1057	///	1067	///
1058	/// FPDT Version (as defined in ACPI 5.1 spec.)	1068	/// FPDT Version (as defined in ACPI 5.1 spec.)
1059	///	1069	///
1060	#define EFI_ACPI_5_1_FIRMWARE_PERFORMANCE_DATA_TABLE_REVISION 0x01	1070	#define EFI_ACPI_5_1_FIRMWARE_PERFORMANCE_DATA_TABLE_REVISION 0x01
1061		1071
1062	///	1072	///
1063	/// FPDT Performance Record Types	1073	/// FPDT Performance Record Types
1064	///	1074	///
1065	#define EFI_ACPI_5_1_FPDT_RECORD_TYPE_FIRMWARE_BASIC_BOOT_POINTER 0x0000	1075	#define EFI_ACPI_5_1_FPDT_RECORD_TYPE_FIRMWARE_BASIC_BOOT_POINTER 0x0000
1066	#define EFI_ACPI_5_1_FPDT_RECORD_TYPE_S3_PERFORMANCE_TABLE_POINTER 0x0001	1076	#define EFI_ACPI_5_1_FPDT_RECORD_TYPE_S3_PERFORMANCE_TABLE_POINTER 0x0001
1067		1077
1068	///	1078	///
1069	/// FPDT Performance Record Revision	1079	/// FPDT Performance Record Revision
1070	///	1080	///
1071	#define EFI_ACPI_5_1_FPDT_RECORD_REVISION_FIRMWARE_BASIC_BOOT_POINTER 0x01	1081	#define EFI_ACPI_5_1_FPDT_RECORD_REVISION_FIRMWARE_BASIC_BOOT_POINTER 0x01
1072	#define EFI_ACPI_5_1_FPDT_RECORD_REVISION_S3_PERFORMANCE_TABLE_POINTER 0x01	1082	#define EFI_ACPI_5_1_FPDT_RECORD_REVISION_S3_PERFORMANCE_TABLE_POINTER 0x01
1073		1083
1074	///	1084	///
1075	/// FPDT Runtime Performance Record Types	1085	/// FPDT Runtime Performance Record Types
1076	///	1086	///
1077	#define EFI_ACPI_5_1_FPDT_RUNTIME_RECORD_TYPE_S3_RESUME 0x0000	1087	#define EFI_ACPI_5_1_FPDT_RUNTIME_RECORD_TYPE_S3_RESUME 0x0000
1078	#define EFI_ACPI_5_1_FPDT_RUNTIME_RECORD_TYPE_S3_SUSPEND 0x0001	1088	#define EFI_ACPI_5_1_FPDT_RUNTIME_RECORD_TYPE_S3_SUSPEND 0x0001
1079	#define EFI_ACPI_5_1_FPDT_RUNTIME_RECORD_TYPE_FIRMWARE_BASIC_BOOT 0x0002	1089	#define EFI_ACPI_5_1_FPDT_RUNTIME_RECORD_TYPE_FIRMWARE_BASIC_BOOT 0x0002
1080		1090
1081	///	1091	///
1082	/// FPDT Runtime Performance Record Revision	1092	/// FPDT Runtime Performance Record Revision
Lines 1089-1165 typedef struct { Link Here
1089	/// FPDT Performance Record header	1099	/// FPDT Performance Record header
1090	///	1100	///
1091	typedef struct {	1101	typedef struct {
1092	UINT16 Type;	1102	UINT16 Type;
1093	UINT8 Length;	1103	UINT8 Length;
1094	UINT8 Revision;	1104	UINT8 Revision;
1095	} EFI_ACPI_5_1_FPDT_PERFORMANCE_RECORD_HEADER;	1105	} EFI_ACPI_5_1_FPDT_PERFORMANCE_RECORD_HEADER;
1096		1106
1097	///	1107	///
1098	/// FPDT Performance Table header	1108	/// FPDT Performance Table header
1099	///	1109	///
1100	typedef struct {	1110	typedef struct {
1101	UINT32 Signature;	1111	UINT32 Signature;
1102	UINT32 Length;	1112	UINT32 Length;
1103	} EFI_ACPI_5_1_FPDT_PERFORMANCE_TABLE_HEADER;	1113	} EFI_ACPI_5_1_FPDT_PERFORMANCE_TABLE_HEADER;
1104		1114
1105	///	1115	///
1106	/// FPDT Firmware Basic Boot Performance Pointer Record Structure	1116	/// FPDT Firmware Basic Boot Performance Pointer Record Structure
1107	///	1117	///
1108	typedef struct {	1118	typedef struct {
1109	EFI_ACPI_5_1_FPDT_PERFORMANCE_RECORD_HEADER Header;	1119	EFI_ACPI_5_1_FPDT_PERFORMANCE_RECORD_HEADER Header;
1110	UINT32 Reserved;	1120	UINT32 Reserved;
1111	///	1121	///
1112	/// 64-bit processor-relative physical address of the Basic Boot Performance Table.	1122	/// 64-bit processor-relative physical address of the Basic Boot Performance Table.
1113	///	1123	///
1114	UINT64 BootPerformanceTablePointer;	1124	UINT64 BootPerformanceTablePointer;
1115	} EFI_ACPI_5_1_FPDT_BOOT_PERFORMANCE_TABLE_POINTER_RECORD;	1125	} EFI_ACPI_5_1_FPDT_BOOT_PERFORMANCE_TABLE_POINTER_RECORD;
1116		1126
1117	///	1127	///
1118	/// FPDT S3 Performance Table Pointer Record Structure	1128	/// FPDT S3 Performance Table Pointer Record Structure
1119	///	1129	///
1120	typedef struct {	1130	typedef struct {
1121	EFI_ACPI_5_1_FPDT_PERFORMANCE_RECORD_HEADER Header;	1131	EFI_ACPI_5_1_FPDT_PERFORMANCE_RECORD_HEADER Header;
1122	UINT32 Reserved;	1132	UINT32 Reserved;
1123	///	1133	///
1124	/// 64-bit processor-relative physical address of the S3 Performance Table.	1134	/// 64-bit processor-relative physical address of the S3 Performance Table.
1125	///	1135	///
1126	UINT64 S3PerformanceTablePointer;	1136	UINT64 S3PerformanceTablePointer;
1127	} EFI_ACPI_5_1_FPDT_S3_PERFORMANCE_TABLE_POINTER_RECORD;	1137	} EFI_ACPI_5_1_FPDT_S3_PERFORMANCE_TABLE_POINTER_RECORD;
1128		1138
1129	///	1139	///
1130	/// FPDT Firmware Basic Boot Performance Record Structure	1140	/// FPDT Firmware Basic Boot Performance Record Structure
1131	///	1141	///
1132	typedef struct {	1142	typedef struct {
1133	EFI_ACPI_5_1_FPDT_PERFORMANCE_RECORD_HEADER Header;	1143	EFI_ACPI_5_1_FPDT_PERFORMANCE_RECORD_HEADER Header;
1134	UINT32 Reserved;	1144	UINT32 Reserved;
1135	///	1145	///
1136	/// Timer value logged at the beginning of firmware image execution.	1146	/// Timer value logged at the beginning of firmware image execution.
1137	/// This may not always be zero or near zero.	1147	/// This may not always be zero or near zero.
1138	///	1148	///
1139	UINT64 ResetEnd;	1149	UINT64 ResetEnd;
1140	///	1150	///
1141	/// Timer value logged just prior to loading the OS boot loader into memory.	1151	/// Timer value logged just prior to loading the OS boot loader into memory.
1142	/// For non-UEFI compatible boots, this field must be zero.	1152	/// For non-UEFI compatible boots, this field must be zero.
1143	///	1153	///
1144	UINT64 OsLoaderLoadImageStart;	1154	UINT64 OsLoaderLoadImageStart;
1145	///	1155	///
1146	/// Timer value logged just prior to launching the previously loaded OS boot loader image.	1156	/// Timer value logged just prior to launching the previously loaded OS boot loader image.
1147	/// For non-UEFI compatible boots, the timer value logged will be just prior	1157	/// For non-UEFI compatible boots, the timer value logged will be just prior
1148	/// to the INT 19h handler invocation.	1158	/// to the INT 19h handler invocation.
1149	///	1159	///
1150	UINT64 OsLoaderStartImageStart;	1160	UINT64 OsLoaderStartImageStart;
1151	///	1161	///
1152	/// Timer value logged at the point when the OS loader calls the	1162	/// Timer value logged at the point when the OS loader calls the
1153	/// ExitBootServices function for UEFI compatible firmware.	1163	/// ExitBootServices function for UEFI compatible firmware.
1154	/// For non-UEFI compatible boots, this field must be zero.	1164	/// For non-UEFI compatible boots, this field must be zero.
1155	///	1165	///
1156	UINT64 ExitBootServicesEntry;	1166	UINT64 ExitBootServicesEntry;
1157	///	1167	///
1158	/// Timer value logged at the point just prior to when the OS loader gaining	1168	/// Timer value logged at the point just prior to when the OS loader gaining
1159	/// control back from calls the ExitBootServices function for UEFI compatible firmware.	1169	/// control back from calls the ExitBootServices function for UEFI compatible firmware.
1160	/// For non-UEFI compatible boots, this field must be zero.	1170	/// For non-UEFI compatible boots, this field must be zero.
1161	///	1171	///
1162	UINT64 ExitBootServicesExit;	1172	UINT64 ExitBootServicesExit;
1163	} EFI_ACPI_5_1_FPDT_FIRMWARE_BASIC_BOOT_RECORD;	1173	} EFI_ACPI_5_1_FPDT_FIRMWARE_BASIC_BOOT_RECORD;
1164		1174
1165	///	1175	///
Lines 1171-1177 typedef struct { Link Here
1171	// FPDT Firmware Basic Boot Performance Table	1181	// FPDT Firmware Basic Boot Performance Table
1172	//	1182	//
1173	typedef struct {	1183	typedef struct {
1174	EFI_ACPI_5_1_FPDT_PERFORMANCE_TABLE_HEADER Header;	1184	EFI_ACPI_5_1_FPDT_PERFORMANCE_TABLE_HEADER Header;
1175	//	1185	//
1176	// one or more Performance Records.	1186	// one or more Performance Records.
1177	//	1187	//
Lines 1186-1192 typedef struct { Link Here
1186	// FPDT Firmware S3 Boot Performance Table	1196	// FPDT Firmware S3 Boot Performance Table
1187	//	1197	//
1188	typedef struct {	1198	typedef struct {
1189	EFI_ACPI_5_1_FPDT_PERFORMANCE_TABLE_HEADER Header;	1199	EFI_ACPI_5_1_FPDT_PERFORMANCE_TABLE_HEADER Header;
1190	//	1200	//
1191	// one or more Performance Records.	1201	// one or more Performance Records.
1192	//	1202	//
Lines 1196-1398 typedef struct { Link Here
1196	/// FPDT Basic S3 Resume Performance Record	1206	/// FPDT Basic S3 Resume Performance Record
1197	///	1207	///
1198	typedef struct {	1208	typedef struct {
1199	EFI_ACPI_5_1_FPDT_PERFORMANCE_RECORD_HEADER Header;	1209	EFI_ACPI_5_1_FPDT_PERFORMANCE_RECORD_HEADER Header;
1200	///	1210	///
1201	/// A count of the number of S3 resume cycles since the last full boot sequence.	1211	/// A count of the number of S3 resume cycles since the last full boot sequence.
1202	///	1212	///
1203	UINT32 ResumeCount;	1213	UINT32 ResumeCount;
1204	///	1214	///
1205	/// Timer recorded at the end of BIOS S3 resume, just prior to handoff to the	1215	/// Timer recorded at the end of BIOS S3 resume, just prior to handoff to the
1206	/// OS waking vector. Only the most recent resume cycle's time is retained.	1216	/// OS waking vector. Only the most recent resume cycle's time is retained.
1207	///	1217	///
1208	UINT64 FullResume;	1218	UINT64 FullResume;
1209	///	1219	///
1210	/// Average timer value of all resume cycles logged since the last full boot	1220	/// Average timer value of all resume cycles logged since the last full boot
1211	/// sequence, including the most recent resume. Note that the entire log of	1221	/// sequence, including the most recent resume. Note that the entire log of
1212	/// timer values does not need to be retained in order to calculate this average.	1222	/// timer values does not need to be retained in order to calculate this average.
1213	///	1223	///
1214	UINT64 AverageResume;	1224	UINT64 AverageResume;
1215	} EFI_ACPI_5_1_FPDT_S3_RESUME_RECORD;	1225	} EFI_ACPI_5_1_FPDT_S3_RESUME_RECORD;
1216		1226
1217	///	1227	///
1218	/// FPDT Basic S3 Suspend Performance Record	1228	/// FPDT Basic S3 Suspend Performance Record
1219	///	1229	///
1220	typedef struct {	1230	typedef struct {
1221	EFI_ACPI_5_1_FPDT_PERFORMANCE_RECORD_HEADER Header;	1231	EFI_ACPI_5_1_FPDT_PERFORMANCE_RECORD_HEADER Header;
1222	///	1232	///
1223	/// Timer value recorded at the OS write to SLP_TYP upon entry to S3.	1233	/// Timer value recorded at the OS write to SLP_TYP upon entry to S3.
1224	/// Only the most recent suspend cycle's timer value is retained.	1234	/// Only the most recent suspend cycle's timer value is retained.
1225	///	1235	///
1226	UINT64 SuspendStart;	1236	UINT64 SuspendStart;
1227	///	1237	///
1228	/// Timer value recorded at the final firmware write to SLP_TYP (or other	1238	/// Timer value recorded at the final firmware write to SLP_TYP (or other
1229	/// mechanism) used to trigger hardware entry to S3.	1239	/// mechanism) used to trigger hardware entry to S3.
1230	/// Only the most recent suspend cycle's timer value is retained.	1240	/// Only the most recent suspend cycle's timer value is retained.
1231	///	1241	///
1232	UINT64 SuspendEnd;	1242	UINT64 SuspendEnd;
1233	} EFI_ACPI_5_1_FPDT_S3_SUSPEND_RECORD;	1243	} EFI_ACPI_5_1_FPDT_S3_SUSPEND_RECORD;
1234		1244
1235	///	1245	///
1236	/// Firmware Performance Record Table definition.	1246	/// Firmware Performance Record Table definition.
1237	///	1247	///
1238	typedef struct {	1248	typedef struct {
1239	EFI_ACPI_DESCRIPTION_HEADER Header;	1249	EFI_ACPI_DESCRIPTION_HEADER Header;
1240	} EFI_ACPI_5_1_FIRMWARE_PERFORMANCE_RECORD_TABLE;	1250	} EFI_ACPI_5_1_FIRMWARE_PERFORMANCE_RECORD_TABLE;
1241		1251
1242	///	1252	///
1243	/// Generic Timer Description Table definition.	1253	/// Generic Timer Description Table definition.
1244	///	1254	///
1245	typedef struct {	1255	typedef struct {
1246	EFI_ACPI_DESCRIPTION_HEADER Header;	1256	EFI_ACPI_DESCRIPTION_HEADER Header;
1247	UINT64 CntControlBasePhysicalAddress;	1257	UINT64 CntControlBasePhysicalAddress;
1248	UINT32 Reserved;	1258	UINT32 Reserved;
1249	UINT32 SecurePL1TimerGSIV;	1259	UINT32 SecurePL1TimerGSIV;
1250	UINT32 SecurePL1TimerFlags;	1260	UINT32 SecurePL1TimerFlags;
1251	UINT32 NonSecurePL1TimerGSIV;	1261	UINT32 NonSecurePL1TimerGSIV;
1252	UINT32 NonSecurePL1TimerFlags;	1262	UINT32 NonSecurePL1TimerFlags;
1253	UINT32 VirtualTimerGSIV;	1263	UINT32 VirtualTimerGSIV;
1254	UINT32 VirtualTimerFlags;	1264	UINT32 VirtualTimerFlags;
1255	UINT32 NonSecurePL2TimerGSIV;	1265	UINT32 NonSecurePL2TimerGSIV;
1256	UINT32 NonSecurePL2TimerFlags;	1266	UINT32 NonSecurePL2TimerFlags;
1257	UINT64 CntReadBasePhysicalAddress;	1267	UINT64 CntReadBasePhysicalAddress;
1258	UINT32 PlatformTimerCount;	1268	UINT32 PlatformTimerCount;
1259	UINT32 PlatformTimerOffset;	1269	UINT32 PlatformTimerOffset;
1260	} EFI_ACPI_5_1_GENERIC_TIMER_DESCRIPTION_TABLE;	1270	} EFI_ACPI_5_1_GENERIC_TIMER_DESCRIPTION_TABLE;
1261		1271
1262	///	1272	///
1263	/// GTDT Version (as defined in ACPI 5.1 spec.)	1273	/// GTDT Version (as defined in ACPI 5.1 spec.)
1264	///	1274	///
1265	#define EFI_ACPI_5_1_GENERIC_TIMER_DESCRIPTION_TABLE_REVISION 0x02	1275	#define EFI_ACPI_5_1_GENERIC_TIMER_DESCRIPTION_TABLE_REVISION 0x02
1266		1276
1267	///	1277	///
1268	/// Timer Flags. All other bits are reserved and must be 0.	1278	/// Timer Flags. All other bits are reserved and must be 0.
1269	///	1279	///
1270	#define EFI_ACPI_5_1_GTDT_TIMER_FLAG_TIMER_INTERRUPT_MODE BIT0	1280	#define EFI_ACPI_5_1_GTDT_TIMER_FLAG_TIMER_INTERRUPT_MODE BIT0
1271	#define EFI_ACPI_5_1_GTDT_TIMER_FLAG_TIMER_INTERRUPT_POLARITY BIT1	1281	#define EFI_ACPI_5_1_GTDT_TIMER_FLAG_TIMER_INTERRUPT_POLARITY BIT1
1272	#define EFI_ACPI_5_1_GTDT_TIMER_FLAG_ALWAYS_ON_CAPABILITY BIT2	1282	#define EFI_ACPI_5_1_GTDT_TIMER_FLAG_ALWAYS_ON_CAPABILITY BIT2
1273		1283
1274	///	1284	///
1275	/// Platform Timer Type	1285	/// Platform Timer Type
1276	///	1286	///
1277	#define EFI_ACPI_5_1_GTDT_GT_BLOCK 0	1287	#define EFI_ACPI_5_1_GTDT_GT_BLOCK 0
1278	#define EFI_ACPI_5_1_GTDT_SBSA_GENERIC_WATCHDOG 1	1288	#define EFI_ACPI_5_1_GTDT_SBSA_GENERIC_WATCHDOG 1
1279		1289
1280	///	1290	///
1281	/// GT Block Structure	1291	/// GT Block Structure
1282	///	1292	///
1283	typedef struct {	1293	typedef struct {
1284	UINT8 Type;	1294	UINT8 Type;
1285	UINT16 Length;	1295	UINT16 Length;
1286	UINT8 Reserved;	1296	UINT8 Reserved;
1287	UINT64 CntCtlBase;	1297	UINT64 CntCtlBase;
1288	UINT32 GTBlockTimerCount;	1298	UINT32 GTBlockTimerCount;
1289	UINT32 GTBlockTimerOffset;	1299	UINT32 GTBlockTimerOffset;
1290	} EFI_ACPI_5_1_GTDT_GT_BLOCK_STRUCTURE;	1300	} EFI_ACPI_5_1_GTDT_GT_BLOCK_STRUCTURE;
1291		1301
1292	///	1302	///
1293	/// GT Block Timer Structure	1303	/// GT Block Timer Structure
1294	///	1304	///
1295	typedef struct {	1305	typedef struct {
1296	UINT8 GTFrameNumber;	1306	UINT8 GTFrameNumber;
1297	UINT8 Reserved[3];	1307	UINT8 Reserved[3];
1298	UINT64 CntBaseX;	1308	UINT64 CntBaseX;
1299	UINT64 CntEL0BaseX;	1309	UINT64 CntEL0BaseX;
1300	UINT32 GTxPhysicalTimerGSIV;	1310	UINT32 GTxPhysicalTimerGSIV;
1301	UINT32 GTxPhysicalTimerFlags;	1311	UINT32 GTxPhysicalTimerFlags;
1302	UINT32 GTxVirtualTimerGSIV;	1312	UINT32 GTxVirtualTimerGSIV;
1303	UINT32 GTxVirtualTimerFlags;	1313	UINT32 GTxVirtualTimerFlags;
1304	UINT32 GTxCommonFlags;	1314	UINT32 GTxCommonFlags;
1305	} EFI_ACPI_5_1_GTDT_GT_BLOCK_TIMER_STRUCTURE;	1315	} EFI_ACPI_5_1_GTDT_GT_BLOCK_TIMER_STRUCTURE;
1306		1316
1307	///	1317	///
1308	/// GT Block Physical Timers and Virtual Timers Flags. All other bits are reserved and must be 0.	1318	/// GT Block Physical Timers and Virtual Timers Flags. All other bits are reserved and must be 0.
1309	///	1319	///
1310	#define EFI_ACPI_5_1_GTDT_GT_BLOCK_TIMER_FLAG_TIMER_INTERRUPT_MODE BIT0	1320	#define EFI_ACPI_5_1_GTDT_GT_BLOCK_TIMER_FLAG_TIMER_INTERRUPT_MODE BIT0
1311	#define EFI_ACPI_5_1_GTDT_GT_BLOCK_TIMER_FLAG_TIMER_INTERRUPT_POLARITY BIT1	1321	#define EFI_ACPI_5_1_GTDT_GT_BLOCK_TIMER_FLAG_TIMER_INTERRUPT_POLARITY BIT1
1312		1322
1313	///	1323	///
1314	/// Common Flags Flags. All other bits are reserved and must be 0.	1324	/// Common Flags Flags. All other bits are reserved and must be 0.
1315	///	1325	///
1316	#define EFI_ACPI_5_1_GTDT_GT_BLOCK_COMMON_FLAG_SECURE_TIMER BIT0	1326	#define EFI_ACPI_5_1_GTDT_GT_BLOCK_COMMON_FLAG_SECURE_TIMER BIT0
1317	#define EFI_ACPI_5_1_GTDT_GT_BLOCK_COMMON_FLAG_ALWAYS_ON_CAPABILITY BIT1	1327	#define EFI_ACPI_5_1_GTDT_GT_BLOCK_COMMON_FLAG_ALWAYS_ON_CAPABILITY BIT1
1318		1328
1319	///	1329	///
1320	/// SBSA Generic Watchdog Structure	1330	/// SBSA Generic Watchdog Structure
1321	///	1331	///
1322	typedef struct {	1332	typedef struct {
1323	UINT8 Type;	1333	UINT8 Type;
1324	UINT16 Length;	1334	UINT16 Length;
1325	UINT8 Reserved;	1335	UINT8 Reserved;
1326	UINT64 RefreshFramePhysicalAddress;	1336	UINT64 RefreshFramePhysicalAddress;
1327	UINT64 WatchdogControlFramePhysicalAddress;	1337	UINT64 WatchdogControlFramePhysicalAddress;
1328	UINT32 WatchdogTimerGSIV;	1338	UINT32 WatchdogTimerGSIV;
1329	UINT32 WatchdogTimerFlags;	1339	UINT32 WatchdogTimerFlags;
1330	} EFI_ACPI_5_1_GTDT_SBSA_GENERIC_WATCHDOG_STRUCTURE;	1340	} EFI_ACPI_5_1_GTDT_SBSA_GENERIC_WATCHDOG_STRUCTURE;
1331		1341
1332	///	1342	///
1333	/// SBSA Generic Watchdog Timer Flags. All other bits are reserved and must be 0.	1343	/// SBSA Generic Watchdog Timer Flags. All other bits are reserved and must be 0.
1334	///	1344	///
1335	#define EFI_ACPI_5_1_GTDT_SBSA_GENERIC_WATCHDOG_FLAG_TIMER_INTERRUPT_MODE BIT0	1345	#define EFI_ACPI_5_1_GTDT_SBSA_GENERIC_WATCHDOG_FLAG_TIMER_INTERRUPT_MODE BIT0
1336	#define EFI_ACPI_5_1_GTDT_SBSA_GENERIC_WATCHDOG_FLAG_TIMER_INTERRUPT_POLARITY BIT1	1346	#define EFI_ACPI_5_1_GTDT_SBSA_GENERIC_WATCHDOG_FLAG_TIMER_INTERRUPT_POLARITY BIT1
1337	#define EFI_ACPI_5_1_GTDT_SBSA_GENERIC_WATCHDOG_FLAG_SECURE_TIMER BIT2	1347	#define EFI_ACPI_5_1_GTDT_SBSA_GENERIC_WATCHDOG_FLAG_SECURE_TIMER BIT2
1338		1348
1339	///	1349	///
1340	/// Boot Error Record Table (BERT)	1350	/// Boot Error Record Table (BERT)
1341	///	1351	///
1342	typedef struct {	1352	typedef struct {
1343	EFI_ACPI_DESCRIPTION_HEADER Header;	1353	EFI_ACPI_DESCRIPTION_HEADER Header;
1344	UINT32 BootErrorRegionLength;	1354	UINT32 BootErrorRegionLength;
1345	UINT64 BootErrorRegion;	1355	UINT64 BootErrorRegion;
1346	} EFI_ACPI_5_1_BOOT_ERROR_RECORD_TABLE_HEADER;	1356	} EFI_ACPI_5_1_BOOT_ERROR_RECORD_TABLE_HEADER;
1347		1357
1348	///	1358	///
1349	/// BERT Version (as defined in ACPI 5.1 spec.)	1359	/// BERT Version (as defined in ACPI 5.1 spec.)
1350	///	1360	///
1351	#define EFI_ACPI_5_1_BOOT_ERROR_RECORD_TABLE_REVISION 0x01	1361	#define EFI_ACPI_5_1_BOOT_ERROR_RECORD_TABLE_REVISION 0x01
1352		1362
1353	///	1363	///
1354	/// Boot Error Region Block Status Definition	1364	/// Boot Error Region Block Status Definition
1355	///	1365	///
1356	typedef struct {	1366	typedef struct {
1357	UINT32 UncorrectableErrorValid:1;	1367	UINT32 UncorrectableErrorValid : 1;
1358	UINT32 CorrectableErrorValid:1;	1368	UINT32 CorrectableErrorValid : 1;
1359	UINT32 MultipleUncorrectableErrors:1;	1369	UINT32 MultipleUncorrectableErrors : 1;
1360	UINT32 MultipleCorrectableErrors:1;	1370	UINT32 MultipleCorrectableErrors : 1;
1361	UINT32 ErrorDataEntryCount:10;	1371	UINT32 ErrorDataEntryCount : 10;
1362	UINT32 Reserved:18;	1372	UINT32 Reserved : 18;
1363	} EFI_ACPI_5_1_ERROR_BLOCK_STATUS;	1373	} EFI_ACPI_5_1_ERROR_BLOCK_STATUS;
1364		1374
1365	///	1375	///
1366	/// Boot Error Region Definition	1376	/// Boot Error Region Definition
1367	///	1377	///
1368	typedef struct {	1378	typedef struct {
1369	EFI_ACPI_5_1_ERROR_BLOCK_STATUS BlockStatus;	1379	EFI_ACPI_5_1_ERROR_BLOCK_STATUS BlockStatus;
1370	UINT32 RawDataOffset;	1380	UINT32 RawDataOffset;
1371	UINT32 RawDataLength;	1381	UINT32 RawDataLength;
1372	UINT32 DataLength;	1382	UINT32 DataLength;
1373	UINT32 ErrorSeverity;	1383	UINT32 ErrorSeverity;
1374	} EFI_ACPI_5_1_BOOT_ERROR_REGION_STRUCTURE;	1384	} EFI_ACPI_5_1_BOOT_ERROR_REGION_STRUCTURE;
1375		1385
1376	//	1386	//
1377	// Boot Error Severity types	1387	// Boot Error Severity types
1378	//	1388	//
1379	#define EFI_ACPI_5_1_ERROR_SEVERITY_CORRECTABLE 0x00	1389	#define EFI_ACPI_5_1_ERROR_SEVERITY_RECOVERABLE 0x00
1380	#define EFI_ACPI_5_1_ERROR_SEVERITY_FATAL 0x01	1390	#define EFI_ACPI_5_1_ERROR_SEVERITY_FATAL 0x01
1381	#define EFI_ACPI_5_1_ERROR_SEVERITY_CORRECTED 0x02	1391	#define EFI_ACPI_5_1_ERROR_SEVERITY_CORRECTED 0x02
1382	#define EFI_ACPI_5_1_ERROR_SEVERITY_NONE 0x03	1392	#define EFI_ACPI_5_1_ERROR_SEVERITY_NONE 0x03
		1393	//
		1394	// The term 'Correctable' is no longer being used as an error severity of the
		1395	// reported error since ACPI Specification Version 5.1 Errata B.
		1396	// The below macro is considered as deprecated and should no longer be used.
		1397	//
		1398	#define EFI_ACPI_5_1_ERROR_SEVERITY_CORRECTABLE 0x00
1383		1399
1384	///	1400	///
1385	/// Generic Error Data Entry Definition	1401	/// Generic Error Data Entry Definition
1386	///	1402	///
1387	typedef struct {	1403	typedef struct {
1388	UINT8 SectionType[16];	1404	UINT8 SectionType[16];
1389	UINT32 ErrorSeverity;	1405	UINT32 ErrorSeverity;
1390	UINT16 Revision;	1406	UINT16 Revision;
1391	UINT8 ValidationBits;	1407	UINT8 ValidationBits;
1392	UINT8 Flags;	1408	UINT8 Flags;
1393	UINT32 ErrorDataLength;	1409	UINT32 ErrorDataLength;
1394	UINT8 FruId[16];	1410	UINT8 FruId[16];
1395	UINT8 FruText[20];	1411	UINT8 FruText[20];
1396	} EFI_ACPI_5_1_GENERIC_ERROR_DATA_ENTRY_STRUCTURE;	1412	} EFI_ACPI_5_1_GENERIC_ERROR_DATA_ENTRY_STRUCTURE;
1397		1413
1398	///	1414	///
Lines 1404-1417 typedef struct { Link Here
1404	/// HEST - Hardware Error Source Table	1420	/// HEST - Hardware Error Source Table
1405	///	1421	///
1406	typedef struct {	1422	typedef struct {
1407	EFI_ACPI_DESCRIPTION_HEADER Header;	1423	EFI_ACPI_DESCRIPTION_HEADER Header;
1408	UINT32 ErrorSourceCount;	1424	UINT32 ErrorSourceCount;
1409	} EFI_ACPI_5_1_HARDWARE_ERROR_SOURCE_TABLE_HEADER;	1425	} EFI_ACPI_5_1_HARDWARE_ERROR_SOURCE_TABLE_HEADER;
1410		1426
1411	///	1427	///
1412	/// HEST Version (as defined in ACPI 5.1 spec.)	1428	/// HEST Version (as defined in ACPI 5.1 spec.)
1413	///	1429	///
1414	#define EFI_ACPI_5_1_HARDWARE_ERROR_SOURCE_TABLE_REVISION 0x01	1430	#define EFI_ACPI_5_1_HARDWARE_ERROR_SOURCE_TABLE_REVISION 0x01
1415		1431
1416	//	1432	//
1417	// Error Source structure types.	1433	// Error Source structure types.
Lines 1427-1829 typedef struct { Link Here
1427	//	1443	//
1428	// Error Source structure flags.	1444	// Error Source structure flags.
1429	//	1445	//
1430	#define EFI_ACPI_5_1_ERROR_SOURCE_FLAG_FIRMWARE_FIRST (1 << 0)	1446	#define EFI_ACPI_5_1_ERROR_SOURCE_FLAG_FIRMWARE_FIRST (1 << 0)
1431	#define EFI_ACPI_5_1_ERROR_SOURCE_FLAG_GLOBAL (1 << 1)	1447	#define EFI_ACPI_5_1_ERROR_SOURCE_FLAG_GLOBAL (1 << 1)
1432		1448
1433	///	1449	///
1434	/// IA-32 Architecture Machine Check Exception Structure Definition	1450	/// IA-32 Architecture Machine Check Exception Structure Definition
1435	///	1451	///
1436	typedef struct {	1452	typedef struct {
1437	UINT16 Type;	1453	UINT16 Type;
1438	UINT16 SourceId;	1454	UINT16 SourceId;
1439	UINT8 Reserved0[2];	1455	UINT8 Reserved0[2];
1440	UINT8 Flags;	1456	UINT8 Flags;
1441	UINT8 Enabled;	1457	UINT8 Enabled;
1442	UINT32 NumberOfRecordsToPreAllocate;	1458	UINT32 NumberOfRecordsToPreAllocate;
1443	UINT32 MaxSectionsPerRecord;	1459	UINT32 MaxSectionsPerRecord;
1444	UINT64 GlobalCapabilityInitData;	1460	UINT64 GlobalCapabilityInitData;
1445	UINT64 GlobalControlInitData;	1461	UINT64 GlobalControlInitData;
1446	UINT8 NumberOfHardwareBanks;	1462	UINT8 NumberOfHardwareBanks;
1447	UINT8 Reserved1[7];	1463	UINT8 Reserved1[7];
1448	} EFI_ACPI_5_1_IA32_ARCHITECTURE_MACHINE_CHECK_EXCEPTION_STRUCTURE;	1464	} EFI_ACPI_5_1_IA32_ARCHITECTURE_MACHINE_CHECK_EXCEPTION_STRUCTURE;
1449		1465
1450	///	1466	///
1451	/// IA-32 Architecture Machine Check Bank Structure Definition	1467	/// IA-32 Architecture Machine Check Bank Structure Definition
1452	///	1468	///
1453	typedef struct {	1469	typedef struct {
1454	UINT8 BankNumber;	1470	UINT8 BankNumber;
1455	UINT8 ClearStatusOnInitialization;	1471	UINT8 ClearStatusOnInitialization;
1456	UINT8 StatusDataFormat;	1472	UINT8 StatusDataFormat;
1457	UINT8 Reserved0;	1473	UINT8 Reserved0;
1458	UINT32 ControlRegisterMsrAddress;	1474	UINT32 ControlRegisterMsrAddress;
1459	UINT64 ControlInitData;	1475	UINT64 ControlInitData;
1460	UINT32 StatusRegisterMsrAddress;	1476	UINT32 StatusRegisterMsrAddress;
1461	UINT32 AddressRegisterMsrAddress;	1477	UINT32 AddressRegisterMsrAddress;
1462	UINT32 MiscRegisterMsrAddress;	1478	UINT32 MiscRegisterMsrAddress;
1463	} EFI_ACPI_5_1_IA32_ARCHITECTURE_MACHINE_CHECK_ERROR_BANK_STRUCTURE;	1479	} EFI_ACPI_5_1_IA32_ARCHITECTURE_MACHINE_CHECK_ERROR_BANK_STRUCTURE;
1464		1480
1465	///	1481	///
1466	/// IA-32 Architecture Machine Check Bank Structure MCA data format	1482	/// IA-32 Architecture Machine Check Bank Structure MCA data format
1467	///	1483	///
1468	#define EFI_ACPI_5_1_IA32_ARCHITECTURE_MACHINE_CHECK_ERROR_DATA_FORMAT_IA32 0x00	1484	#define EFI_ACPI_5_1_IA32_ARCHITECTURE_MACHINE_CHECK_ERROR_DATA_FORMAT_IA32 0x00
1469	#define EFI_ACPI_5_1_IA32_ARCHITECTURE_MACHINE_CHECK_ERROR_DATA_FORMAT_INTEL64 0x01	1485	#define EFI_ACPI_5_1_IA32_ARCHITECTURE_MACHINE_CHECK_ERROR_DATA_FORMAT_INTEL64 0x01
1470	#define EFI_ACPI_5_1_IA32_ARCHITECTURE_MACHINE_CHECK_ERROR_DATA_FORMAT_AMD64 0x02	1486	#define EFI_ACPI_5_1_IA32_ARCHITECTURE_MACHINE_CHECK_ERROR_DATA_FORMAT_AMD64 0x02
1471		1487
1472	//	1488	//
1473	// Hardware Error Notification types. All other values are reserved	1489	// Hardware Error Notification types. All other values are reserved
1474	//	1490	//
1475	#define EFI_ACPI_5_1_HARDWARE_ERROR_NOTIFICATION_POLLED 0x00	1491	#define EFI_ACPI_5_1_HARDWARE_ERROR_NOTIFICATION_POLLED 0x00
1476	#define EFI_ACPI_5_1_HARDWARE_ERROR_NOTIFICATION_EXTERNAL_INTERRUPT 0x01	1492	#define EFI_ACPI_5_1_HARDWARE_ERROR_NOTIFICATION_EXTERNAL_INTERRUPT 0x01
1477	#define EFI_ACPI_5_1_HARDWARE_ERROR_NOTIFICATION_LOCAL_INTERRUPT 0x02	1493	#define EFI_ACPI_5_1_HARDWARE_ERROR_NOTIFICATION_LOCAL_INTERRUPT 0x02
1478	#define EFI_ACPI_5_1_HARDWARE_ERROR_NOTIFICATION_SCI 0x03	1494	#define EFI_ACPI_5_1_HARDWARE_ERROR_NOTIFICATION_SCI 0x03
1479	#define EFI_ACPI_5_1_HARDWARE_ERROR_NOTIFICATION_NMI 0x04	1495	#define EFI_ACPI_5_1_HARDWARE_ERROR_NOTIFICATION_NMI 0x04
1480		1496
1481	///	1497	///
1482	/// Hardware Error Notification Configuration Write Enable Structure Definition	1498	/// Hardware Error Notification Configuration Write Enable Structure Definition
1483	///	1499	///
1484	typedef struct {	1500	typedef struct {
1485	UINT16 Type:1;	1501	UINT16 Type : 1;
1486	UINT16 PollInterval:1;	1502	UINT16 PollInterval : 1;
1487	UINT16 SwitchToPollingThresholdValue:1;	1503	UINT16 SwitchToPollingThresholdValue : 1;
1488	UINT16 SwitchToPollingThresholdWindow:1;	1504	UINT16 SwitchToPollingThresholdWindow : 1;
1489	UINT16 ErrorThresholdValue:1;	1505	UINT16 ErrorThresholdValue : 1;
1490	UINT16 ErrorThresholdWindow:1;	1506	UINT16 ErrorThresholdWindow : 1;
1491	UINT16 Reserved:10;	1507	UINT16 Reserved : 10;
1492	} EFI_ACPI_5_1_HARDWARE_ERROR_NOTIFICATION_CONFIGURATION_WRITE_ENABLE_STRUCTURE;	1508	} EFI_ACPI_5_1_HARDWARE_ERROR_NOTIFICATION_CONFIGURATION_WRITE_ENABLE_STRUCTURE;
1493		1509
1494	///	1510	///
1495	/// Hardware Error Notification Structure Definition	1511	/// Hardware Error Notification Structure Definition
1496	///	1512	///
1497	typedef struct {	1513	typedef struct {
1498	UINT8 Type;	1514	UINT8 Type;
1499	UINT8 Length;	1515	UINT8 Length;
1500	EFI_ACPI_5_1_HARDWARE_ERROR_NOTIFICATION_CONFIGURATION_WRITE_ENABLE_STRUCTURE ConfigurationWriteEnable;	1516	EFI_ACPI_5_1_HARDWARE_ERROR_NOTIFICATION_CONFIGURATION_WRITE_ENABLE_STRUCTURE ConfigurationWriteEnable;
1501	UINT32 PollInterval;	1517	UINT32 PollInterval;
1502	UINT32 Vector;	1518	UINT32 Vector;
1503	UINT32 SwitchToPollingThresholdValue;	1519	UINT32 SwitchToPollingThresholdValue;
1504	UINT32 SwitchToPollingThresholdWindow;	1520	UINT32 SwitchToPollingThresholdWindow;
1505	UINT32 ErrorThresholdValue;	1521	UINT32 ErrorThresholdValue;
1506	UINT32 ErrorThresholdWindow;	1522	UINT32 ErrorThresholdWindow;
1507	} EFI_ACPI_5_1_HARDWARE_ERROR_NOTIFICATION_STRUCTURE;	1523	} EFI_ACPI_5_1_HARDWARE_ERROR_NOTIFICATION_STRUCTURE;
1508		1524
1509	///	1525	///
1510	/// IA-32 Architecture Corrected Machine Check Structure Definition	1526	/// IA-32 Architecture Corrected Machine Check Structure Definition
1511	///	1527	///
1512	typedef struct {	1528	typedef struct {
1513	UINT16 Type;	1529	UINT16 Type;
1514	UINT16 SourceId;	1530	UINT16 SourceId;
1515	UINT8 Reserved0[2];	1531	UINT8 Reserved0[2];
1516	UINT8 Flags;	1532	UINT8 Flags;
1517	UINT8 Enabled;	1533	UINT8 Enabled;
1518	UINT32 NumberOfRecordsToPreAllocate;	1534	UINT32 NumberOfRecordsToPreAllocate;
1519	UINT32 MaxSectionsPerRecord;	1535	UINT32 MaxSectionsPerRecord;
1520	EFI_ACPI_5_1_HARDWARE_ERROR_NOTIFICATION_STRUCTURE NotificationStructure;	1536	EFI_ACPI_5_1_HARDWARE_ERROR_NOTIFICATION_STRUCTURE NotificationStructure;
1521	UINT8 NumberOfHardwareBanks;	1537	UINT8 NumberOfHardwareBanks;
1522	UINT8 Reserved1[3];	1538	UINT8 Reserved1[3];
1523	} EFI_ACPI_5_1_IA32_ARCHITECTURE_CORRECTED_MACHINE_CHECK_STRUCTURE;	1539	} EFI_ACPI_5_1_IA32_ARCHITECTURE_CORRECTED_MACHINE_CHECK_STRUCTURE;
1524		1540
1525	///	1541	///
1526	/// IA-32 Architecture NMI Error Structure Definition	1542	/// IA-32 Architecture NMI Error Structure Definition
1527	///	1543	///
1528	typedef struct {	1544	typedef struct {
1529	UINT16 Type;	1545	UINT16 Type;
1530	UINT16 SourceId;	1546	UINT16 SourceId;
1531	UINT8 Reserved0[2];	1547	UINT8 Reserved0[2];
1532	UINT32 NumberOfRecordsToPreAllocate;	1548	UINT32 NumberOfRecordsToPreAllocate;
1533	UINT32 MaxSectionsPerRecord;	1549	UINT32 MaxSectionsPerRecord;
1534	UINT32 MaxRawDataLength;	1550	UINT32 MaxRawDataLength;
1535	} EFI_ACPI_5_1_IA32_ARCHITECTURE_NMI_ERROR_STRUCTURE;	1551	} EFI_ACPI_5_1_IA32_ARCHITECTURE_NMI_ERROR_STRUCTURE;
1536		1552
1537	///	1553	///
1538	/// PCI Express Root Port AER Structure Definition	1554	/// PCI Express Root Port AER Structure Definition
1539	///	1555	///
1540	typedef struct {	1556	typedef struct {
1541	UINT16 Type;	1557	UINT16 Type;
1542	UINT16 SourceId;	1558	UINT16 SourceId;
1543	UINT8 Reserved0[2];	1559	UINT8 Reserved0[2];
1544	UINT8 Flags;	1560	UINT8 Flags;
1545	UINT8 Enabled;	1561	UINT8 Enabled;
1546	UINT32 NumberOfRecordsToPreAllocate;	1562	UINT32 NumberOfRecordsToPreAllocate;
1547	UINT32 MaxSectionsPerRecord;	1563	UINT32 MaxSectionsPerRecord;
1548	UINT32 Bus;	1564	UINT32 Bus;
1549	UINT16 Device;	1565	UINT16 Device;
1550	UINT16 Function;	1566	UINT16 Function;
1551	UINT16 DeviceControl;	1567	UINT16 DeviceControl;
1552	UINT8 Reserved1[2];	1568	UINT8 Reserved1[2];
1553	UINT32 UncorrectableErrorMask;	1569	UINT32 UncorrectableErrorMask;
1554	UINT32 UncorrectableErrorSeverity;	1570	UINT32 UncorrectableErrorSeverity;
1555	UINT32 CorrectableErrorMask;	1571	UINT32 CorrectableErrorMask;
1556	UINT32 AdvancedErrorCapabilitiesAndControl;	1572	UINT32 AdvancedErrorCapabilitiesAndControl;
1557	UINT32 RootErrorCommand;	1573	UINT32 RootErrorCommand;
1558	} EFI_ACPI_5_1_PCI_EXPRESS_ROOT_PORT_AER_STRUCTURE;	1574	} EFI_ACPI_5_1_PCI_EXPRESS_ROOT_PORT_AER_STRUCTURE;
1559		1575
1560	///	1576	///
1561	/// PCI Express Device AER Structure Definition	1577	/// PCI Express Device AER Structure Definition
1562	///	1578	///
1563	typedef struct {	1579	typedef struct {
1564	UINT16 Type;	1580	UINT16 Type;
1565	UINT16 SourceId;	1581	UINT16 SourceId;
1566	UINT8 Reserved0[2];	1582	UINT8 Reserved0[2];
1567	UINT8 Flags;	1583	UINT8 Flags;
1568	UINT8 Enabled;	1584	UINT8 Enabled;
1569	UINT32 NumberOfRecordsToPreAllocate;	1585	UINT32 NumberOfRecordsToPreAllocate;
1570	UINT32 MaxSectionsPerRecord;	1586	UINT32 MaxSectionsPerRecord;
1571	UINT32 Bus;	1587	UINT32 Bus;
1572	UINT16 Device;	1588	UINT16 Device;
1573	UINT16 Function;	1589	UINT16 Function;
1574	UINT16 DeviceControl;	1590	UINT16 DeviceControl;
1575	UINT8 Reserved1[2];	1591	UINT8 Reserved1[2];
1576	UINT32 UncorrectableErrorMask;	1592	UINT32 UncorrectableErrorMask;
1577	UINT32 UncorrectableErrorSeverity;	1593	UINT32 UncorrectableErrorSeverity;
1578	UINT32 CorrectableErrorMask;	1594	UINT32 CorrectableErrorMask;
1579	UINT32 AdvancedErrorCapabilitiesAndControl;	1595	UINT32 AdvancedErrorCapabilitiesAndControl;
1580	} EFI_ACPI_5_1_PCI_EXPRESS_DEVICE_AER_STRUCTURE;	1596	} EFI_ACPI_5_1_PCI_EXPRESS_DEVICE_AER_STRUCTURE;
1581		1597
1582	///	1598	///
1583	/// PCI Express Bridge AER Structure Definition	1599	/// PCI Express Bridge AER Structure Definition
1584	///	1600	///
1585	typedef struct {	1601	typedef struct {
1586	UINT16 Type;	1602	UINT16 Type;
1587	UINT16 SourceId;	1603	UINT16 SourceId;
1588	UINT8 Reserved0[2];	1604	UINT8 Reserved0[2];
1589	UINT8 Flags;	1605	UINT8 Flags;
1590	UINT8 Enabled;	1606	UINT8 Enabled;
1591	UINT32 NumberOfRecordsToPreAllocate;	1607	UINT32 NumberOfRecordsToPreAllocate;
1592	UINT32 MaxSectionsPerRecord;	1608	UINT32 MaxSectionsPerRecord;
1593	UINT32 Bus;	1609	UINT32 Bus;
1594	UINT16 Device;	1610	UINT16 Device;
1595	UINT16 Function;	1611	UINT16 Function;
1596	UINT16 DeviceControl;	1612	UINT16 DeviceControl;
1597	UINT8 Reserved1[2];	1613	UINT8 Reserved1[2];
1598	UINT32 UncorrectableErrorMask;	1614	UINT32 UncorrectableErrorMask;
1599	UINT32 UncorrectableErrorSeverity;	1615	UINT32 UncorrectableErrorSeverity;
1600	UINT32 CorrectableErrorMask;	1616	UINT32 CorrectableErrorMask;
1601	UINT32 AdvancedErrorCapabilitiesAndControl;	1617	UINT32 AdvancedErrorCapabilitiesAndControl;
1602	UINT32 SecondaryUncorrectableErrorMask;	1618	UINT32 SecondaryUncorrectableErrorMask;
1603	UINT32 SecondaryUncorrectableErrorSeverity;	1619	UINT32 SecondaryUncorrectableErrorSeverity;
1604	UINT32 SecondaryAdvancedErrorCapabilitiesAndControl;	1620	UINT32 SecondaryAdvancedErrorCapabilitiesAndControl;
1605	} EFI_ACPI_5_1_PCI_EXPRESS_BRIDGE_AER_STRUCTURE;	1621	} EFI_ACPI_5_1_PCI_EXPRESS_BRIDGE_AER_STRUCTURE;
1606		1622
1607	///	1623	///
1608	/// Generic Hardware Error Source Structure Definition	1624	/// Generic Hardware Error Source Structure Definition
1609	///	1625	///
1610	typedef struct {	1626	typedef struct {
1611	UINT16 Type;	1627	UINT16 Type;
1612	UINT16 SourceId;	1628	UINT16 SourceId;
1613	UINT16 RelatedSourceId;	1629	UINT16 RelatedSourceId;
1614	UINT8 Flags;	1630	UINT8 Flags;
1615	UINT8 Enabled;	1631	UINT8 Enabled;
1616	UINT32 NumberOfRecordsToPreAllocate;	1632	UINT32 NumberOfRecordsToPreAllocate;
1617	UINT32 MaxSectionsPerRecord;	1633	UINT32 MaxSectionsPerRecord;
1618	UINT32 MaxRawDataLength;	1634	UINT32 MaxRawDataLength;
1619	EFI_ACPI_5_1_GENERIC_ADDRESS_STRUCTURE ErrorStatusAddress;	1635	EFI_ACPI_5_1_GENERIC_ADDRESS_STRUCTURE ErrorStatusAddress;
1620	EFI_ACPI_5_1_HARDWARE_ERROR_NOTIFICATION_STRUCTURE NotificationStructure;	1636	EFI_ACPI_5_1_HARDWARE_ERROR_NOTIFICATION_STRUCTURE NotificationStructure;
1621	UINT32 ErrorStatusBlockLength;	1637	UINT32 ErrorStatusBlockLength;
1622	} EFI_ACPI_5_1_GENERIC_HARDWARE_ERROR_SOURCE_STRUCTURE;	1638	} EFI_ACPI_5_1_GENERIC_HARDWARE_ERROR_SOURCE_STRUCTURE;
1623		1639
1624	///	1640	///
1625	/// Generic Error Status Definition	1641	/// Generic Error Status Definition
1626	///	1642	///
1627	typedef struct {	1643	typedef struct {
1628	EFI_ACPI_5_1_ERROR_BLOCK_STATUS BlockStatus;	1644	EFI_ACPI_5_1_ERROR_BLOCK_STATUS BlockStatus;
1629	UINT32 RawDataOffset;	1645	UINT32 RawDataOffset;
1630	UINT32 RawDataLength;	1646	UINT32 RawDataLength;
1631	UINT32 DataLength;	1647	UINT32 DataLength;
1632	UINT32 ErrorSeverity;	1648	UINT32 ErrorSeverity;
1633	} EFI_ACPI_5_1_GENERIC_ERROR_STATUS_STRUCTURE;	1649	} EFI_ACPI_5_1_GENERIC_ERROR_STATUS_STRUCTURE;
1634		1650
1635	///	1651	///
1636	/// ERST - Error Record Serialization Table	1652	/// ERST - Error Record Serialization Table
1637	///	1653	///
1638	typedef struct {	1654	typedef struct {
1639	EFI_ACPI_DESCRIPTION_HEADER Header;	1655	EFI_ACPI_DESCRIPTION_HEADER Header;
1640	UINT32 SerializationHeaderSize;	1656	UINT32 SerializationHeaderSize;
1641	UINT8 Reserved0[4];	1657	UINT8 Reserved0[4];
1642	UINT32 InstructionEntryCount;	1658	UINT32 InstructionEntryCount;
1643	} EFI_ACPI_5_1_ERROR_RECORD_SERIALIZATION_TABLE_HEADER;	1659	} EFI_ACPI_5_1_ERROR_RECORD_SERIALIZATION_TABLE_HEADER;
1644		1660
1645	///	1661	///
1646	/// ERST Version (as defined in ACPI 5.1 spec.)	1662	/// ERST Version (as defined in ACPI 5.1 spec.)
1647	///	1663	///
1648	#define EFI_ACPI_5_1_ERROR_RECORD_SERIALIZATION_TABLE_REVISION 0x01	1664	#define EFI_ACPI_5_1_ERROR_RECORD_SERIALIZATION_TABLE_REVISION 0x01
1649		1665
1650	///	1666	///
1651	/// ERST Serialization Actions	1667	/// ERST Serialization Actions
1652	///	1668	///
1653	#define EFI_ACPI_5_1_ERST_BEGIN_WRITE_OPERATION 0x00	1669	#define EFI_ACPI_5_1_ERST_BEGIN_WRITE_OPERATION 0x00
1654	#define EFI_ACPI_5_1_ERST_BEGIN_READ_OPERATION 0x01	1670	#define EFI_ACPI_5_1_ERST_BEGIN_READ_OPERATION 0x01
1655	#define EFI_ACPI_5_1_ERST_BEGIN_CLEAR_OPERATION 0x02	1671	#define EFI_ACPI_5_1_ERST_BEGIN_CLEAR_OPERATION 0x02
1656	#define EFI_ACPI_5_1_ERST_END_OPERATION 0x03	1672	#define EFI_ACPI_5_1_ERST_END_OPERATION 0x03
1657	#define EFI_ACPI_5_1_ERST_SET_RECORD_OFFSET 0x04	1673	#define EFI_ACPI_5_1_ERST_SET_RECORD_OFFSET 0x04
1658	#define EFI_ACPI_5_1_ERST_EXECUTE_OPERATION 0x05	1674	#define EFI_ACPI_5_1_ERST_EXECUTE_OPERATION 0x05
1659	#define EFI_ACPI_5_1_ERST_CHECK_BUSY_STATUS 0x06	1675	#define EFI_ACPI_5_1_ERST_CHECK_BUSY_STATUS 0x06
1660	#define EFI_ACPI_5_1_ERST_GET_COMMAND_STATUS 0x07	1676	#define EFI_ACPI_5_1_ERST_GET_COMMAND_STATUS 0x07
1661	#define EFI_ACPI_5_1_ERST_GET_RECORD_IDENTIFIER 0x08	1677	#define EFI_ACPI_5_1_ERST_GET_RECORD_IDENTIFIER 0x08
1662	#define EFI_ACPI_5_1_ERST_SET_RECORD_IDENTIFIER 0x09	1678	#define EFI_ACPI_5_1_ERST_SET_RECORD_IDENTIFIER 0x09
1663	#define EFI_ACPI_5_1_ERST_GET_RECORD_COUNT 0x0A	1679	#define EFI_ACPI_5_1_ERST_GET_RECORD_COUNT 0x0A
1664	#define EFI_ACPI_5_1_ERST_BEGIN_DUMMY_WRITE_OPERATION 0x0B	1680	#define EFI_ACPI_5_1_ERST_BEGIN_DUMMY_WRITE_OPERATION 0x0B
1665	#define EFI_ACPI_5_1_ERST_GET_ERROR_LOG_ADDRESS_RANGE 0x0D	1681	#define EFI_ACPI_5_1_ERST_GET_ERROR_LOG_ADDRESS_RANGE 0x0D
1666	#define EFI_ACPI_5_1_ERST_GET_ERROR_LOG_ADDRESS_RANGE_LENGTH 0x0E	1682	#define EFI_ACPI_5_1_ERST_GET_ERROR_LOG_ADDRESS_RANGE_LENGTH 0x0E
1667	#define EFI_ACPI_5_1_ERST_GET_ERROR_LOG_ADDRESS_RANGE_ATTRIBUTES 0x0F	1683	#define EFI_ACPI_5_1_ERST_GET_ERROR_LOG_ADDRESS_RANGE_ATTRIBUTES 0x0F
1668		1684
1669	///	1685	///
1670	/// ERST Action Command Status	1686	/// ERST Action Command Status
1671	///	1687	///
1672	#define EFI_ACPI_5_1_ERST_STATUS_SUCCESS 0x00	1688	#define EFI_ACPI_5_1_ERST_STATUS_SUCCESS 0x00
1673	#define EFI_ACPI_5_1_ERST_STATUS_NOT_ENOUGH_SPACE 0x01	1689	#define EFI_ACPI_5_1_ERST_STATUS_NOT_ENOUGH_SPACE 0x01
1674	#define EFI_ACPI_5_1_ERST_STATUS_HARDWARE_NOT_AVAILABLE 0x02	1690	#define EFI_ACPI_5_1_ERST_STATUS_HARDWARE_NOT_AVAILABLE 0x02
1675	#define EFI_ACPI_5_1_ERST_STATUS_FAILED 0x03	1691	#define EFI_ACPI_5_1_ERST_STATUS_FAILED 0x03
1676	#define EFI_ACPI_5_1_ERST_STATUS_RECORD_STORE_EMPTY 0x04	1692	#define EFI_ACPI_5_1_ERST_STATUS_RECORD_STORE_EMPTY 0x04
1677	#define EFI_ACPI_5_1_ERST_STATUS_RECORD_NOT_FOUND 0x05	1693	#define EFI_ACPI_5_1_ERST_STATUS_RECORD_NOT_FOUND 0x05
1678		1694
1679	///	1695	///
1680	/// ERST Serialization Instructions	1696	/// ERST Serialization Instructions
1681	///	1697	///
1682	#define EFI_ACPI_5_1_ERST_READ_REGISTER 0x00	1698	#define EFI_ACPI_5_1_ERST_READ_REGISTER 0x00
1683	#define EFI_ACPI_5_1_ERST_READ_REGISTER_VALUE 0x01	1699	#define EFI_ACPI_5_1_ERST_READ_REGISTER_VALUE 0x01
1684	#define EFI_ACPI_5_1_ERST_WRITE_REGISTER 0x02	1700	#define EFI_ACPI_5_1_ERST_WRITE_REGISTER 0x02
1685	#define EFI_ACPI_5_1_ERST_WRITE_REGISTER_VALUE 0x03	1701	#define EFI_ACPI_5_1_ERST_WRITE_REGISTER_VALUE 0x03
1686	#define EFI_ACPI_5_1_ERST_NOOP 0x04	1702	#define EFI_ACPI_5_1_ERST_NOOP 0x04
1687	#define EFI_ACPI_5_1_ERST_LOAD_VAR1 0x05	1703	#define EFI_ACPI_5_1_ERST_LOAD_VAR1 0x05
1688	#define EFI_ACPI_5_1_ERST_LOAD_VAR2 0x06	1704	#define EFI_ACPI_5_1_ERST_LOAD_VAR2 0x06
1689	#define EFI_ACPI_5_1_ERST_STORE_VAR1 0x07	1705	#define EFI_ACPI_5_1_ERST_STORE_VAR1 0x07
1690	#define EFI_ACPI_5_1_ERST_ADD 0x08	1706	#define EFI_ACPI_5_1_ERST_ADD 0x08
1691	#define EFI_ACPI_5_1_ERST_SUBTRACT 0x09	1707	#define EFI_ACPI_5_1_ERST_SUBTRACT 0x09
1692	#define EFI_ACPI_5_1_ERST_ADD_VALUE 0x0A	1708	#define EFI_ACPI_5_1_ERST_ADD_VALUE 0x0A
1693	#define EFI_ACPI_5_1_ERST_SUBTRACT_VALUE 0x0B	1709	#define EFI_ACPI_5_1_ERST_SUBTRACT_VALUE 0x0B
1694	#define EFI_ACPI_5_1_ERST_STALL 0x0C	1710	#define EFI_ACPI_5_1_ERST_STALL 0x0C
1695	#define EFI_ACPI_5_1_ERST_STALL_WHILE_TRUE 0x0D	1711	#define EFI_ACPI_5_1_ERST_STALL_WHILE_TRUE 0x0D
1696	#define EFI_ACPI_5_1_ERST_SKIP_NEXT_INSTRUCTION_IF_TRUE 0x0E	1712	#define EFI_ACPI_5_1_ERST_SKIP_NEXT_INSTRUCTION_IF_TRUE 0x0E
1697	#define EFI_ACPI_5_1_ERST_GOTO 0x0F	1713	#define EFI_ACPI_5_1_ERST_GOTO 0x0F
1698	#define EFI_ACPI_5_1_ERST_SET_SRC_ADDRESS_BASE 0x10	1714	#define EFI_ACPI_5_1_ERST_SET_SRC_ADDRESS_BASE 0x10
1699	#define EFI_ACPI_5_1_ERST_SET_DST_ADDRESS_BASE 0x11	1715	#define EFI_ACPI_5_1_ERST_SET_DST_ADDRESS_BASE 0x11
1700	#define EFI_ACPI_5_1_ERST_MOVE_DATA 0x12	1716	#define EFI_ACPI_5_1_ERST_MOVE_DATA 0x12
1701		1717
1702	///	1718	///
1703	/// ERST Instruction Flags	1719	/// ERST Instruction Flags
1704	///	1720	///
1705	#define EFI_ACPI_5_1_ERST_PRESERVE_REGISTER 0x01	1721	#define EFI_ACPI_5_1_ERST_PRESERVE_REGISTER 0x01
1706		1722
1707	///	1723	///
1708	/// ERST Serialization Instruction Entry	1724	/// ERST Serialization Instruction Entry
1709	///	1725	///
1710	typedef struct {	1726	typedef struct {
1711	UINT8 SerializationAction;	1727	UINT8 SerializationAction;
1712	UINT8 Instruction;	1728	UINT8 Instruction;
1713	UINT8 Flags;	1729	UINT8 Flags;
1714	UINT8 Reserved0;	1730	UINT8 Reserved0;
1715	EFI_ACPI_5_1_GENERIC_ADDRESS_STRUCTURE RegisterRegion;	1731	EFI_ACPI_5_1_GENERIC_ADDRESS_STRUCTURE RegisterRegion;
1716	UINT64 Value;	1732	UINT64 Value;
1717	UINT64 Mask;	1733	UINT64 Mask;
1718	} EFI_ACPI_5_1_ERST_SERIALIZATION_INSTRUCTION_ENTRY;	1734	} EFI_ACPI_5_1_ERST_SERIALIZATION_INSTRUCTION_ENTRY;
1719		1735
1720	///	1736	///
1721	/// EINJ - Error Injection Table	1737	/// EINJ - Error Injection Table
1722	///	1738	///
1723	typedef struct {	1739	typedef struct {
1724	EFI_ACPI_DESCRIPTION_HEADER Header;	1740	EFI_ACPI_DESCRIPTION_HEADER Header;
1725	UINT32 InjectionHeaderSize;	1741	UINT32 InjectionHeaderSize;
1726	UINT8 InjectionFlags;	1742	UINT8 InjectionFlags;
1727	UINT8 Reserved0[3];	1743	UINT8 Reserved0[3];
1728	UINT32 InjectionEntryCount;	1744	UINT32 InjectionEntryCount;
1729	} EFI_ACPI_5_1_ERROR_INJECTION_TABLE_HEADER;	1745	} EFI_ACPI_5_1_ERROR_INJECTION_TABLE_HEADER;
1730		1746
1731	///	1747	///
1732	/// EINJ Version (as defined in ACPI 5.1 spec.)	1748	/// EINJ Version (as defined in ACPI 5.1 spec.)
1733	///	1749	///
1734	#define EFI_ACPI_5_1_ERROR_INJECTION_TABLE_REVISION 0x01	1750	#define EFI_ACPI_5_1_ERROR_INJECTION_TABLE_REVISION 0x01
1735		1751
1736	///	1752	///
1737	/// EINJ Error Injection Actions	1753	/// EINJ Error Injection Actions
1738	///	1754	///
1739	#define EFI_ACPI_5_1_EINJ_BEGIN_INJECTION_OPERATION 0x00	1755	#define EFI_ACPI_5_1_EINJ_BEGIN_INJECTION_OPERATION 0x00
1740	#define EFI_ACPI_5_1_EINJ_GET_TRIGGER_ERROR_ACTION_TABLE 0x01	1756	#define EFI_ACPI_5_1_EINJ_GET_TRIGGER_ERROR_ACTION_TABLE 0x01
1741	#define EFI_ACPI_5_1_EINJ_SET_ERROR_TYPE 0x02	1757	#define EFI_ACPI_5_1_EINJ_SET_ERROR_TYPE 0x02
1742	#define EFI_ACPI_5_1_EINJ_GET_ERROR_TYPE 0x03	1758	#define EFI_ACPI_5_1_EINJ_GET_ERROR_TYPE 0x03
1743	#define EFI_ACPI_5_1_EINJ_END_OPERATION 0x04	1759	#define EFI_ACPI_5_1_EINJ_END_OPERATION 0x04
1744	#define EFI_ACPI_5_1_EINJ_EXECUTE_OPERATION 0x05	1760	#define EFI_ACPI_5_1_EINJ_EXECUTE_OPERATION 0x05
1745	#define EFI_ACPI_5_1_EINJ_CHECK_BUSY_STATUS 0x06	1761	#define EFI_ACPI_5_1_EINJ_CHECK_BUSY_STATUS 0x06
1746	#define EFI_ACPI_5_1_EINJ_GET_COMMAND_STATUS 0x07	1762	#define EFI_ACPI_5_1_EINJ_GET_COMMAND_STATUS 0x07
1747	#define EFI_ACPI_5_1_EINJ_TRIGGER_ERROR 0xFF	1763	#define EFI_ACPI_5_1_EINJ_TRIGGER_ERROR 0xFF
1748		1764
1749	///	1765	///
1750	/// EINJ Action Command Status	1766	/// EINJ Action Command Status
1751	///	1767	///
1752	#define EFI_ACPI_5_1_EINJ_STATUS_SUCCESS 0x00	1768	#define EFI_ACPI_5_1_EINJ_STATUS_SUCCESS 0x00
1753	#define EFI_ACPI_5_1_EINJ_STATUS_UNKNOWN_FAILURE 0x01	1769	#define EFI_ACPI_5_1_EINJ_STATUS_UNKNOWN_FAILURE 0x01
1754	#define EFI_ACPI_5_1_EINJ_STATUS_INVALID_ACCESS 0x02	1770	#define EFI_ACPI_5_1_EINJ_STATUS_INVALID_ACCESS 0x02
1755		1771
1756	///	1772	///
1757	/// EINJ Error Type Definition	1773	/// EINJ Error Type Definition
1758	///	1774	///
1759	#define EFI_ACPI_5_1_EINJ_ERROR_PROCESSOR_CORRECTABLE (1 << 0)	1775	#define EFI_ACPI_5_1_EINJ_ERROR_PROCESSOR_CORRECTABLE (1 << 0)
1760	#define EFI_ACPI_5_1_EINJ_ERROR_PROCESSOR_UNCORRECTABLE_NONFATAL (1 << 1)	1776	#define EFI_ACPI_5_1_EINJ_ERROR_PROCESSOR_UNCORRECTABLE_NONFATAL (1 << 1)
1761	#define EFI_ACPI_5_1_EINJ_ERROR_PROCESSOR_UNCORRECTABLE_FATAL (1 << 2)	1777	#define EFI_ACPI_5_1_EINJ_ERROR_PROCESSOR_UNCORRECTABLE_FATAL (1 << 2)
1762	#define EFI_ACPI_5_1_EINJ_ERROR_MEMORY_CORRECTABLE (1 << 3)	1778	#define EFI_ACPI_5_1_EINJ_ERROR_MEMORY_CORRECTABLE (1 << 3)
1763	#define EFI_ACPI_5_1_EINJ_ERROR_MEMORY_UNCORRECTABLE_NONFATAL (1 << 4)	1779	#define EFI_ACPI_5_1_EINJ_ERROR_MEMORY_UNCORRECTABLE_NONFATAL (1 << 4)
1764	#define EFI_ACPI_5_1_EINJ_ERROR_MEMORY_UNCORRECTABLE_FATAL (1 << 5)	1780	#define EFI_ACPI_5_1_EINJ_ERROR_MEMORY_UNCORRECTABLE_FATAL (1 << 5)
1765	#define EFI_ACPI_5_1_EINJ_ERROR_PCI_EXPRESS_CORRECTABLE (1 << 6)	1781	#define EFI_ACPI_5_1_EINJ_ERROR_PCI_EXPRESS_CORRECTABLE (1 << 6)
1766	#define EFI_ACPI_5_1_EINJ_ERROR_PCI_EXPRESS_UNCORRECTABLE_NONFATAL (1 << 7)	1782	#define EFI_ACPI_5_1_EINJ_ERROR_PCI_EXPRESS_UNCORRECTABLE_NONFATAL (1 << 7)
1767	#define EFI_ACPI_5_1_EINJ_ERROR_PCI_EXPRESS_UNCORRECTABLE_FATAL (1 << 8)	1783	#define EFI_ACPI_5_1_EINJ_ERROR_PCI_EXPRESS_UNCORRECTABLE_FATAL (1 << 8)
1768	#define EFI_ACPI_5_1_EINJ_ERROR_PLATFORM_CORRECTABLE (1 << 9)	1784	#define EFI_ACPI_5_1_EINJ_ERROR_PLATFORM_CORRECTABLE (1 << 9)
1769	#define EFI_ACPI_5_1_EINJ_ERROR_PLATFORM_UNCORRECTABLE_NONFATAL (1 << 10)	1785	#define EFI_ACPI_5_1_EINJ_ERROR_PLATFORM_UNCORRECTABLE_NONFATAL (1 << 10)
1770	#define EFI_ACPI_5_1_EINJ_ERROR_PLATFORM_UNCORRECTABLE_FATAL (1 << 11)	1786	#define EFI_ACPI_5_1_EINJ_ERROR_PLATFORM_UNCORRECTABLE_FATAL (1 << 11)
1771		1787
1772	///	1788	///
1773	/// EINJ Injection Instructions	1789	/// EINJ Injection Instructions
1774	///	1790	///
1775	#define EFI_ACPI_5_1_EINJ_READ_REGISTER 0x00	1791	#define EFI_ACPI_5_1_EINJ_READ_REGISTER 0x00
1776	#define EFI_ACPI_5_1_EINJ_READ_REGISTER_VALUE 0x01	1792	#define EFI_ACPI_5_1_EINJ_READ_REGISTER_VALUE 0x01
1777	#define EFI_ACPI_5_1_EINJ_WRITE_REGISTER 0x02	1793	#define EFI_ACPI_5_1_EINJ_WRITE_REGISTER 0x02
1778	#define EFI_ACPI_5_1_EINJ_WRITE_REGISTER_VALUE 0x03	1794	#define EFI_ACPI_5_1_EINJ_WRITE_REGISTER_VALUE 0x03
1779	#define EFI_ACPI_5_1_EINJ_NOOP 0x04	1795	#define EFI_ACPI_5_1_EINJ_NOOP 0x04
1780		1796
1781	///	1797	///
1782	/// EINJ Instruction Flags	1798	/// EINJ Instruction Flags
1783	///	1799	///
1784	#define EFI_ACPI_5_1_EINJ_PRESERVE_REGISTER 0x01	1800	#define EFI_ACPI_5_1_EINJ_PRESERVE_REGISTER 0x01
1785		1801
1786	///	1802	///
1787	/// EINJ Injection Instruction Entry	1803	/// EINJ Injection Instruction Entry
1788	///	1804	///
1789	typedef struct {	1805	typedef struct {
1790	UINT8 InjectionAction;	1806	UINT8 InjectionAction;
1791	UINT8 Instruction;	1807	UINT8 Instruction;
1792	UINT8 Flags;	1808	UINT8 Flags;
1793	UINT8 Reserved0;	1809	UINT8 Reserved0;
1794	EFI_ACPI_5_1_GENERIC_ADDRESS_STRUCTURE RegisterRegion;	1810	EFI_ACPI_5_1_GENERIC_ADDRESS_STRUCTURE RegisterRegion;
1795	UINT64 Value;	1811	UINT64 Value;
1796	UINT64 Mask;	1812	UINT64 Mask;
1797	} EFI_ACPI_5_1_EINJ_INJECTION_INSTRUCTION_ENTRY;	1813	} EFI_ACPI_5_1_EINJ_INJECTION_INSTRUCTION_ENTRY;
1798		1814
1799	///	1815	///
1800	/// EINJ Trigger Action Table	1816	/// EINJ Trigger Action Table
1801	///	1817	///
1802	typedef struct {	1818	typedef struct {
1803	UINT32 HeaderSize;	1819	UINT32 HeaderSize;
1804	UINT32 Revision;	1820	UINT32 Revision;
1805	UINT32 TableSize;	1821	UINT32 TableSize;
1806	UINT32 EntryCount;	1822	UINT32 EntryCount;
1807	} EFI_ACPI_5_1_EINJ_TRIGGER_ACTION_TABLE;	1823	} EFI_ACPI_5_1_EINJ_TRIGGER_ACTION_TABLE;
1808		1824
1809	///	1825	///
1810	/// Platform Communications Channel Table (PCCT)	1826	/// Platform Communications Channel Table (PCCT)
1811	///	1827	///
1812	typedef struct {	1828	typedef struct {
1813	EFI_ACPI_DESCRIPTION_HEADER Header;	1829	EFI_ACPI_DESCRIPTION_HEADER Header;
1814	UINT32 Flags;	1830	UINT32 Flags;
1815	UINT64 Reserved;	1831	UINT64 Reserved;
1816	} EFI_ACPI_5_1_PLATFORM_COMMUNICATION_CHANNEL_TABLE_HEADER;	1832	} EFI_ACPI_5_1_PLATFORM_COMMUNICATION_CHANNEL_TABLE_HEADER;
1817		1833
1818	///	1834	///
1819	/// PCCT Version (as defined in ACPI 5.1 spec.)	1835	/// PCCT Version (as defined in ACPI 5.1 spec.)
1820	///	1836	///
1821	#define EFI_ACPI_5_1_PLATFORM_COMMUNICATION_CHANNEL_TABLE_REVISION 0x01	1837	#define EFI_ACPI_5_1_PLATFORM_COMMUNICATION_CHANNEL_TABLE_REVISION 0x01
1822		1838
1823	///	1839	///
1824	/// PCCT Global Flags	1840	/// PCCT Global Flags
1825	///	1841	///
1826	#define EFI_ACPI_5_1_PCCT_FLAGS_SCI_DOORBELL BIT0	1842	#define EFI_ACPI_5_1_PCCT_FLAGS_SCI_DOORBELL BIT0
1827		1843
1828	//	1844	//
1829	// PCCT Subspace type	1845	// PCCT Subspace type
Lines 1834-1858 typedef struct { Link Here
1834	/// PCC Subspace Structure Header	1850	/// PCC Subspace Structure Header
1835	///	1851	///
1836	typedef struct {	1852	typedef struct {
1837	UINT8 Type;	1853	UINT8 Type;
1838	UINT8 Length;	1854	UINT8 Length;
1839	} EFI_ACPI_5_1_PCCT_SUBSPACE_HEADER;	1855	} EFI_ACPI_5_1_PCCT_SUBSPACE_HEADER;
1840		1856
1841	///	1857	///
1842	/// Generic Communications Subspace Structure	1858	/// Generic Communications Subspace Structure
1843	///	1859	///
1844	typedef struct {	1860	typedef struct {
1845	UINT8 Type;	1861	UINT8 Type;
1846	UINT8 Length;	1862	UINT8 Length;
1847	UINT8 Reserved[6];	1863	UINT8 Reserved[6];
1848	UINT64 BaseAddress;	1864	UINT64 BaseAddress;
1849	UINT64 AddressLength;	1865	UINT64 AddressLength;
1850	EFI_ACPI_5_1_GENERIC_ADDRESS_STRUCTURE DoorbellRegister;	1866	EFI_ACPI_5_1_GENERIC_ADDRESS_STRUCTURE DoorbellRegister;
1851	UINT64 DoorbellPreserve;	1867	UINT64 DoorbellPreserve;
1852	UINT64 DoorbellWrite;	1868	UINT64 DoorbellWrite;
1853	UINT32 NominalLatency;	1869	UINT32 NominalLatency;
1854	UINT32 MaximumPeriodicAccessRate;	1870	UINT32 MaximumPeriodicAccessRate;
1855	UINT16 MinimumRequestTurnaroundTime;	1871	UINT16 MinimumRequestTurnaroundTime;
1856	} EFI_ACPI_5_1_PCCT_SUBSPACE_GENERIC;	1872	} EFI_ACPI_5_1_PCCT_SUBSPACE_GENERIC;
1857		1873
1858	///	1874	///
Lines 1860-1877 typedef struct { Link Here
1860	///	1876	///
1861		1877
1862	typedef struct {	1878	typedef struct {
1863	UINT8 Command;	1879	UINT8 Command;
1864	UINT8 Reserved:7;	1880	UINT8 Reserved : 7;
1865	UINT8 GenerateSci:1;	1881	UINT8 GenerateSci : 1;
1866	} EFI_ACPI_5_1_PCCT_GENERIC_SHARED_MEMORY_REGION_COMMAND;	1882	} EFI_ACPI_5_1_PCCT_GENERIC_SHARED_MEMORY_REGION_COMMAND;
1867		1883
1868	typedef struct {	1884	typedef struct {
1869	UINT8 CommandComplete:1;	1885	UINT8 CommandComplete : 1;
1870	UINT8 SciDoorbell:1;	1886	UINT8 SciDoorbell : 1;
1871	UINT8 Error:1;	1887	UINT8 Error : 1;
1872	UINT8 PlatformNotification:1;	1888	UINT8 PlatformNotification : 1;
1873	UINT8 Reserved:4;	1889	UINT8 Reserved : 4;
1874	UINT8 Reserved1;	1890	UINT8 Reserved1;
1875	} EFI_ACPI_5_1_PCCT_GENERIC_SHARED_MEMORY_REGION_STATUS;	1891	} EFI_ACPI_5_1_PCCT_GENERIC_SHARED_MEMORY_REGION_STATUS;
1876		1892
1877	typedef struct {	1893	typedef struct {

Lines 1-7 Link Here

(-)b/sys/contrib/edk2/Include/IndustryStandard/Acpi60.h (-944 / +960 lines)
1	/** @file	1	/** @file
2	ACPI 6.0 definitions from the ACPI Specification Revision 6.0 Errata A January, 2016.	2	ACPI 6.0 definitions from the ACPI Specification Revision 6.0 Errata A January, 2016.
3		3
4	Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.<BR>	4	Copyright (c) 2015 - 2022, Intel Corporation. All rights reserved.<BR>
5	(C) Copyright 2015-2016 Hewlett Packard Enterprise Development LP<BR>	5	(C) Copyright 2015-2016 Hewlett Packard Enterprise Development LP<BR>
6	Copyright (c) 2020, ARM Ltd. All rights reserved.<BR>	6	Copyright (c) 2020, ARM Ltd. All rights reserved.<BR>
7	SPDX-License-Identifier: BSD-2-Clause-Patent	7	SPDX-License-Identifier: BSD-2-Clause-Patent
Lines 12-17 Link Here
12		12
13	#include <IndustryStandard/Acpi51.h>	13	#include <IndustryStandard/Acpi51.h>
14		14
		15	///
		16	/// _PSD Revision for ACPI 6.0
		17	///
		18	#define EFI_ACPI_6_0_AML_PSD_REVISION 0
		19
		20	///
		21	/// _CPC Revision for ACPI 6.0
		22	///
		23	#define EFI_ACPI_6_0_AML_CPC_REVISION 2
		24
15	//	25	//
16	// Ensure proper structure formats	26	// Ensure proper structure formats
17	//	27	//
Lines 21-41 Link Here
21	/// ACPI 6.0 Generic Address Space definition	31	/// ACPI 6.0 Generic Address Space definition
22	///	32	///
23	typedef struct {	33	typedef struct {
24	UINT8 AddressSpaceId;	34	UINT8 AddressSpaceId;
25	UINT8 RegisterBitWidth;	35	UINT8 RegisterBitWidth;
26	UINT8 RegisterBitOffset;	36	UINT8 RegisterBitOffset;
27	UINT8 AccessSize;	37	UINT8 AccessSize;
28	UINT64 Address;	38	UINT64 Address;
29	} EFI_ACPI_6_0_GENERIC_ADDRESS_STRUCTURE;	39	} EFI_ACPI_6_0_GENERIC_ADDRESS_STRUCTURE;
30		40
31	//	41	//
32	// Generic Address Space Address IDs	42	// Generic Address Space Address IDs
33	//	43	//
34	#define EFI_ACPI_6_0_SYSTEM_MEMORY 0	44	#define EFI_ACPI_6_0_SYSTEM_MEMORY 0
35	#define EFI_ACPI_6_0_SYSTEM_IO 1	45	#define EFI_ACPI_6_0_SYSTEM_IO 1
36	#define EFI_ACPI_6_0_PCI_CONFIGURATION_SPACE 2	46	#define EFI_ACPI_6_0_PCI_CONFIGURATION_SPACE 2
37	#define EFI_ACPI_6_0_EMBEDDED_CONTROLLER 3	47	#define EFI_ACPI_6_0_EMBEDDED_CONTROLLER 3
38	#define EFI_ACPI_6_0_SMBUS 4	48	#define EFI_ACPI_6_0_SMBUS 4
39	#define EFI_ACPI_6_0_PLATFORM_COMMUNICATION_CHANNEL 0x0A	49	#define EFI_ACPI_6_0_PLATFORM_COMMUNICATION_CHANNEL 0x0A
40	#define EFI_ACPI_6_0_FUNCTIONAL_FIXED_HARDWARE 0x7F	50	#define EFI_ACPI_6_0_FUNCTIONAL_FIXED_HARDWARE 0x7F
41		51
Lines 56-84 typedef struct { Link Here
56	/// Root System Description Pointer Structure	66	/// Root System Description Pointer Structure
57	///	67	///
58	typedef struct {	68	typedef struct {
59	UINT64 Signature;	69	UINT64 Signature;
60	UINT8 Checksum;	70	UINT8 Checksum;
61	UINT8 OemId[6];	71	UINT8 OemId[6];
62	UINT8 Revision;	72	UINT8 Revision;
63	UINT32 RsdtAddress;	73	UINT32 RsdtAddress;
64	UINT32 Length;	74	UINT32 Length;
65	UINT64 XsdtAddress;	75	UINT64 XsdtAddress;
66	UINT8 ExtendedChecksum;	76	UINT8 ExtendedChecksum;
67	UINT8 Reserved[3];	77	UINT8 Reserved[3];
68	} EFI_ACPI_6_0_ROOT_SYSTEM_DESCRIPTION_POINTER;	78	} EFI_ACPI_6_0_ROOT_SYSTEM_DESCRIPTION_POINTER;
69		79
70	///	80	///
71	/// RSD_PTR Revision (as defined in ACPI 6.0 spec.)	81	/// RSD_PTR Revision (as defined in ACPI 6.0 spec.)
72	///	82	///
73	#define EFI_ACPI_6_0_ROOT_SYSTEM_DESCRIPTION_POINTER_REVISION 0x02 ///< ACPISpec (Revision 6.0) says current value is 2	83	#define EFI_ACPI_6_0_ROOT_SYSTEM_DESCRIPTION_POINTER_REVISION 0x02 ///< ACPISpec (Revision 6.0) says current value is 2
74		84
75	///	85	///
76	/// Common table header, this prefaces all ACPI tables, including FACS, but	86	/// Common table header, this prefaces all ACPI tables, including FACS, but
77	/// excluding the RSD PTR structure	87	/// excluding the RSD PTR structure
78	///	88	///
79	typedef struct {	89	typedef struct {
80	UINT32 Signature;	90	UINT32 Signature;
81	UINT32 Length;	91	UINT32 Length;
82	} EFI_ACPI_6_0_COMMON_HEADER;	92	} EFI_ACPI_6_0_COMMON_HEADER;
83		93
84	//	94	//
Lines 90-96 typedef struct { Link Here
90	///	100	///
91	/// RSDT Revision (as defined in ACPI 6.0 spec.)	101	/// RSDT Revision (as defined in ACPI 6.0 spec.)
92	///	102	///
93	#define EFI_ACPI_6_0_ROOT_SYSTEM_DESCRIPTION_TABLE_REVISION 0x01	103	#define EFI_ACPI_6_0_ROOT_SYSTEM_DESCRIPTION_TABLE_REVISION 0x01
94		104
95	//	105	//
96	// Extended System Description Table	106	// Extended System Description Table
Lines 101-174 typedef struct { Link Here
101	///	111	///
102	/// XSDT Revision (as defined in ACPI 6.0 spec.)	112	/// XSDT Revision (as defined in ACPI 6.0 spec.)
103	///	113	///
104	#define EFI_ACPI_6_0_EXTENDED_SYSTEM_DESCRIPTION_TABLE_REVISION 0x01	114	#define EFI_ACPI_6_0_EXTENDED_SYSTEM_DESCRIPTION_TABLE_REVISION 0x01
105		115
106	///	116	///
107	/// Fixed ACPI Description Table Structure (FADT)	117	/// Fixed ACPI Description Table Structure (FADT)
108	///	118	///
109	typedef struct {	119	typedef struct {
110	EFI_ACPI_DESCRIPTION_HEADER Header;	120	EFI_ACPI_DESCRIPTION_HEADER Header;
111	UINT32 FirmwareCtrl;	121	UINT32 FirmwareCtrl;
112	UINT32 Dsdt;	122	UINT32 Dsdt;
113	UINT8 Reserved0;	123	UINT8 Reserved0;
114	UINT8 PreferredPmProfile;	124	UINT8 PreferredPmProfile;
115	UINT16 SciInt;	125	UINT16 SciInt;
116	UINT32 SmiCmd;	126	UINT32 SmiCmd;
117	UINT8 AcpiEnable;	127	UINT8 AcpiEnable;
118	UINT8 AcpiDisable;	128	UINT8 AcpiDisable;
119	UINT8 S4BiosReq;	129	UINT8 S4BiosReq;
120	UINT8 PstateCnt;	130	UINT8 PstateCnt;
121	UINT32 Pm1aEvtBlk;	131	UINT32 Pm1aEvtBlk;
122	UINT32 Pm1bEvtBlk;	132	UINT32 Pm1bEvtBlk;
123	UINT32 Pm1aCntBlk;	133	UINT32 Pm1aCntBlk;
124	UINT32 Pm1bCntBlk;	134	UINT32 Pm1bCntBlk;
125	UINT32 Pm2CntBlk;	135	UINT32 Pm2CntBlk;
126	UINT32 PmTmrBlk;	136	UINT32 PmTmrBlk;
127	UINT32 Gpe0Blk;	137	UINT32 Gpe0Blk;
128	UINT32 Gpe1Blk;	138	UINT32 Gpe1Blk;
129	UINT8 Pm1EvtLen;	139	UINT8 Pm1EvtLen;
130	UINT8 Pm1CntLen;	140	UINT8 Pm1CntLen;
131	UINT8 Pm2CntLen;	141	UINT8 Pm2CntLen;
132	UINT8 PmTmrLen;	142	UINT8 PmTmrLen;
133	UINT8 Gpe0BlkLen;	143	UINT8 Gpe0BlkLen;
134	UINT8 Gpe1BlkLen;	144	UINT8 Gpe1BlkLen;
135	UINT8 Gpe1Base;	145	UINT8 Gpe1Base;
136	UINT8 CstCnt;	146	UINT8 CstCnt;
137	UINT16 PLvl2Lat;	147	UINT16 PLvl2Lat;
138	UINT16 PLvl3Lat;	148	UINT16 PLvl3Lat;
139	UINT16 FlushSize;	149	UINT16 FlushSize;
140	UINT16 FlushStride;	150	UINT16 FlushStride;
141	UINT8 DutyOffset;	151	UINT8 DutyOffset;
142	UINT8 DutyWidth;	152	UINT8 DutyWidth;
143	UINT8 DayAlrm;	153	UINT8 DayAlrm;
144	UINT8 MonAlrm;	154	UINT8 MonAlrm;
145	UINT8 Century;	155	UINT8 Century;
146	UINT16 IaPcBootArch;	156	UINT16 IaPcBootArch;
147	UINT8 Reserved1;	157	UINT8 Reserved1;
148	UINT32 Flags;	158	UINT32 Flags;
149	EFI_ACPI_6_0_GENERIC_ADDRESS_STRUCTURE ResetReg;	159	EFI_ACPI_6_0_GENERIC_ADDRESS_STRUCTURE ResetReg;
150	UINT8 ResetValue;	160	UINT8 ResetValue;
151	UINT16 ArmBootArch;	161	UINT16 ArmBootArch;
152	UINT8 MinorVersion;	162	UINT8 MinorVersion;
153	UINT64 XFirmwareCtrl;	163	UINT64 XFirmwareCtrl;
154	UINT64 XDsdt;	164	UINT64 XDsdt;
155	EFI_ACPI_6_0_GENERIC_ADDRESS_STRUCTURE XPm1aEvtBlk;	165	EFI_ACPI_6_0_GENERIC_ADDRESS_STRUCTURE XPm1aEvtBlk;
156	EFI_ACPI_6_0_GENERIC_ADDRESS_STRUCTURE XPm1bEvtBlk;	166	EFI_ACPI_6_0_GENERIC_ADDRESS_STRUCTURE XPm1bEvtBlk;
157	EFI_ACPI_6_0_GENERIC_ADDRESS_STRUCTURE XPm1aCntBlk;	167	EFI_ACPI_6_0_GENERIC_ADDRESS_STRUCTURE XPm1aCntBlk;
158	EFI_ACPI_6_0_GENERIC_ADDRESS_STRUCTURE XPm1bCntBlk;	168	EFI_ACPI_6_0_GENERIC_ADDRESS_STRUCTURE XPm1bCntBlk;
159	EFI_ACPI_6_0_GENERIC_ADDRESS_STRUCTURE XPm2CntBlk;	169	EFI_ACPI_6_0_GENERIC_ADDRESS_STRUCTURE XPm2CntBlk;
160	EFI_ACPI_6_0_GENERIC_ADDRESS_STRUCTURE XPmTmrBlk;	170	EFI_ACPI_6_0_GENERIC_ADDRESS_STRUCTURE XPmTmrBlk;
161	EFI_ACPI_6_0_GENERIC_ADDRESS_STRUCTURE XGpe0Blk;	171	EFI_ACPI_6_0_GENERIC_ADDRESS_STRUCTURE XGpe0Blk;
162	EFI_ACPI_6_0_GENERIC_ADDRESS_STRUCTURE XGpe1Blk;	172	EFI_ACPI_6_0_GENERIC_ADDRESS_STRUCTURE XGpe1Blk;
163	EFI_ACPI_6_0_GENERIC_ADDRESS_STRUCTURE SleepControlReg;	173	EFI_ACPI_6_0_GENERIC_ADDRESS_STRUCTURE SleepControlReg;
164	EFI_ACPI_6_0_GENERIC_ADDRESS_STRUCTURE SleepStatusReg;	174	EFI_ACPI_6_0_GENERIC_ADDRESS_STRUCTURE SleepStatusReg;
165	UINT64 HypervisorVendorIdentity;	175	UINT64 HypervisorVendorIdentity;
166	} EFI_ACPI_6_0_FIXED_ACPI_DESCRIPTION_TABLE;	176	} EFI_ACPI_6_0_FIXED_ACPI_DESCRIPTION_TABLE;
167		177
168	///	178	///
169	/// FADT Version (as defined in ACPI 6.0 spec.)	179	/// FADT Version (as defined in ACPI 6.0 spec.)
170	///	180	///
171	#define EFI_ACPI_6_0_FIXED_ACPI_DESCRIPTION_TABLE_REVISION 0x06	181	#define EFI_ACPI_6_0_FIXED_ACPI_DESCRIPTION_TABLE_REVISION 0x06
172	#define EFI_ACPI_6_0_FIXED_ACPI_DESCRIPTION_TABLE_MINOR_REVISION 0x00	182	#define EFI_ACPI_6_0_FIXED_ACPI_DESCRIPTION_TABLE_MINOR_REVISION 0x00
173		183
174	//	184	//
Lines 188-249 typedef struct { Link Here
188	// Fixed ACPI Description Table Boot Architecture Flags	198	// Fixed ACPI Description Table Boot Architecture Flags
189	// All other bits are reserved and must be set to 0.	199	// All other bits are reserved and must be set to 0.
190	//	200	//
191	#define EFI_ACPI_6_0_LEGACY_DEVICES BIT0	201	#define EFI_ACPI_6_0_LEGACY_DEVICES BIT0
192	#define EFI_ACPI_6_0_8042 BIT1	202	#define EFI_ACPI_6_0_8042 BIT1
193	#define EFI_ACPI_6_0_VGA_NOT_PRESENT BIT2	203	#define EFI_ACPI_6_0_VGA_NOT_PRESENT BIT2
194	#define EFI_ACPI_6_0_MSI_NOT_SUPPORTED BIT3	204	#define EFI_ACPI_6_0_MSI_NOT_SUPPORTED BIT3
195	#define EFI_ACPI_6_0_PCIE_ASPM_CONTROLS BIT4	205	#define EFI_ACPI_6_0_PCIE_ASPM_CONTROLS BIT4
196	#define EFI_ACPI_6_0_CMOS_RTC_NOT_PRESENT BIT5	206	#define EFI_ACPI_6_0_CMOS_RTC_NOT_PRESENT BIT5
197		207
198	//	208	//
199	// Fixed ACPI Description Table Arm Boot Architecture Flags	209	// Fixed ACPI Description Table Arm Boot Architecture Flags
200	// All other bits are reserved and must be set to 0.	210	// All other bits are reserved and must be set to 0.
201	//	211	//
202	#define EFI_ACPI_6_0_ARM_PSCI_COMPLIANT BIT0	212	#define EFI_ACPI_6_0_ARM_PSCI_COMPLIANT BIT0
203	#define EFI_ACPI_6_0_ARM_PSCI_USE_HVC BIT1	213	#define EFI_ACPI_6_0_ARM_PSCI_USE_HVC BIT1
204		214
205	//	215	//
206	// Fixed ACPI Description Table Fixed Feature Flags	216	// Fixed ACPI Description Table Fixed Feature Flags
207	// All other bits are reserved and must be set to 0.	217	// All other bits are reserved and must be set to 0.
208	//	218	//
209	#define EFI_ACPI_6_0_WBINVD BIT0	219	#define EFI_ACPI_6_0_WBINVD BIT0
210	#define EFI_ACPI_6_0_WBINVD_FLUSH BIT1	220	#define EFI_ACPI_6_0_WBINVD_FLUSH BIT1
211	#define EFI_ACPI_6_0_PROC_C1 BIT2	221	#define EFI_ACPI_6_0_PROC_C1 BIT2
212	#define EFI_ACPI_6_0_P_LVL2_UP BIT3	222	#define EFI_ACPI_6_0_P_LVL2_UP BIT3
213	#define EFI_ACPI_6_0_PWR_BUTTON BIT4	223	#define EFI_ACPI_6_0_PWR_BUTTON BIT4
214	#define EFI_ACPI_6_0_SLP_BUTTON BIT5	224	#define EFI_ACPI_6_0_SLP_BUTTON BIT5
215	#define EFI_ACPI_6_0_FIX_RTC BIT6	225	#define EFI_ACPI_6_0_FIX_RTC BIT6
216	#define EFI_ACPI_6_0_RTC_S4 BIT7	226	#define EFI_ACPI_6_0_RTC_S4 BIT7
217	#define EFI_ACPI_6_0_TMR_VAL_EXT BIT8	227	#define EFI_ACPI_6_0_TMR_VAL_EXT BIT8
218	#define EFI_ACPI_6_0_DCK_CAP BIT9	228	#define EFI_ACPI_6_0_DCK_CAP BIT9
219	#define EFI_ACPI_6_0_RESET_REG_SUP BIT10	229	#define EFI_ACPI_6_0_RESET_REG_SUP BIT10
220	#define EFI_ACPI_6_0_SEALED_CASE BIT11	230	#define EFI_ACPI_6_0_SEALED_CASE BIT11
221	#define EFI_ACPI_6_0_HEADLESS BIT12	231	#define EFI_ACPI_6_0_HEADLESS BIT12
222	#define EFI_ACPI_6_0_CPU_SW_SLP BIT13	232	#define EFI_ACPI_6_0_CPU_SW_SLP BIT13
223	#define EFI_ACPI_6_0_PCI_EXP_WAK BIT14	233	#define EFI_ACPI_6_0_PCI_EXP_WAK BIT14
224	#define EFI_ACPI_6_0_USE_PLATFORM_CLOCK BIT15	234	#define EFI_ACPI_6_0_USE_PLATFORM_CLOCK BIT15
225	#define EFI_ACPI_6_0_S4_RTC_STS_VALID BIT16	235	#define EFI_ACPI_6_0_S4_RTC_STS_VALID BIT16
226	#define EFI_ACPI_6_0_REMOTE_POWER_ON_CAPABLE BIT17	236	#define EFI_ACPI_6_0_REMOTE_POWER_ON_CAPABLE BIT17
227	#define EFI_ACPI_6_0_FORCE_APIC_CLUSTER_MODEL BIT18	237	#define EFI_ACPI_6_0_FORCE_APIC_CLUSTER_MODEL BIT18
228	#define EFI_ACPI_6_0_FORCE_APIC_PHYSICAL_DESTINATION_MODE BIT19	238	#define EFI_ACPI_6_0_FORCE_APIC_PHYSICAL_DESTINATION_MODE BIT19
229	#define EFI_ACPI_6_0_HW_REDUCED_ACPI BIT20	239	#define EFI_ACPI_6_0_HW_REDUCED_ACPI BIT20
230	#define EFI_ACPI_6_0_LOW_POWER_S0_IDLE_CAPABLE BIT21	240	#define EFI_ACPI_6_0_LOW_POWER_S0_IDLE_CAPABLE BIT21
231		241
232	///	242	///
233	/// Firmware ACPI Control Structure	243	/// Firmware ACPI Control Structure
234	///	244	///
235	typedef struct {	245	typedef struct {
236	UINT32 Signature;	246	UINT32 Signature;
237	UINT32 Length;	247	UINT32 Length;
238	UINT32 HardwareSignature;	248	UINT32 HardwareSignature;
239	UINT32 FirmwareWakingVector;	249	UINT32 FirmwareWakingVector;
240	UINT32 GlobalLock;	250	UINT32 GlobalLock;
241	UINT32 Flags;	251	UINT32 Flags;
242	UINT64 XFirmwareWakingVector;	252	UINT64 XFirmwareWakingVector;
243	UINT8 Version;	253	UINT8 Version;
244	UINT8 Reserved0[3];	254	UINT8 Reserved0[3];
245	UINT32 OspmFlags;	255	UINT32 OspmFlags;
246	UINT8 Reserved1[24];	256	UINT8 Reserved1[24];
247	} EFI_ACPI_6_0_FIRMWARE_ACPI_CONTROL_STRUCTURE;	257	} EFI_ACPI_6_0_FIRMWARE_ACPI_CONTROL_STRUCTURE;
248		258
249	///	259	///
Lines 255-268 typedef struct { Link Here
255	/// Firmware Control Structure Feature Flags	265	/// Firmware Control Structure Feature Flags
256	/// All other bits are reserved and must be set to 0.	266	/// All other bits are reserved and must be set to 0.
257	///	267	///
258	#define EFI_ACPI_6_0_S4BIOS_F BIT0	268	#define EFI_ACPI_6_0_S4BIOS_F BIT0
259	#define EFI_ACPI_6_0_64BIT_WAKE_SUPPORTED_F BIT1	269	#define EFI_ACPI_6_0_64BIT_WAKE_SUPPORTED_F BIT1
260		270
261	///	271	///
262	/// OSPM Enabled Firmware Control Structure Flags	272	/// OSPM Enabled Firmware Control Structure Flags
263	/// All other bits are reserved and must be set to 0.	273	/// All other bits are reserved and must be set to 0.
264	///	274	///
265	#define EFI_ACPI_6_0_OSPM_64BIT_WAKE_F BIT0	275	#define EFI_ACPI_6_0_OSPM_64BIT_WAKE_F BIT0
266		276
267	//	277	//
268	// Differentiated System Description Table,	278	// Differentiated System Description Table,
Lines 271-299 typedef struct { Link Here
271	// no definition needed as they are common description table header, the same with	281	// no definition needed as they are common description table header, the same with
272	// EFI_ACPI_DESCRIPTION_HEADER, followed by a definition block.	282	// EFI_ACPI_DESCRIPTION_HEADER, followed by a definition block.
273	//	283	//
274	#define EFI_ACPI_6_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_REVISION 0x02	284	#define EFI_ACPI_6_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_REVISION 0x02
275	#define EFI_ACPI_6_0_SECONDARY_SYSTEM_DESCRIPTION_TABLE_REVISION 0x02	285	#define EFI_ACPI_6_0_SECONDARY_SYSTEM_DESCRIPTION_TABLE_REVISION 0x02
276		286
277	///	287	///
278	/// Multiple APIC Description Table header definition. The rest of the table	288	/// Multiple APIC Description Table header definition. The rest of the table
279	/// must be defined in a platform specific manner.	289	/// must be defined in a platform specific manner.
280	///	290	///
281	typedef struct {	291	typedef struct {
282	EFI_ACPI_DESCRIPTION_HEADER Header;	292	EFI_ACPI_DESCRIPTION_HEADER Header;
283	UINT32 LocalApicAddress;	293	UINT32 LocalApicAddress;
284	UINT32 Flags;	294	UINT32 Flags;
285	} EFI_ACPI_6_0_MULTIPLE_APIC_DESCRIPTION_TABLE_HEADER;	295	} EFI_ACPI_6_0_MULTIPLE_APIC_DESCRIPTION_TABLE_HEADER;
286		296
287	///	297	///
288	/// MADT Revision (as defined in ACPI 6.0 Errata A spec.)	298	/// MADT Revision (as defined in ACPI 6.0 Errata A spec.)
289	///	299	///
290	#define EFI_ACPI_6_0_MULTIPLE_APIC_DESCRIPTION_TABLE_REVISION 0x04	300	#define EFI_ACPI_6_0_MULTIPLE_APIC_DESCRIPTION_TABLE_REVISION 0x04
291		301
292	///	302	///
293	/// Multiple APIC Flags	303	/// Multiple APIC Flags
294	/// All other bits are reserved and must be set to 0.	304	/// All other bits are reserved and must be set to 0.
295	///	305	///
296	#define EFI_ACPI_6_0_PCAT_COMPAT BIT0	306	#define EFI_ACPI_6_0_PCAT_COMPAT BIT0
297		307
298	//	308	//
299	// Multiple APIC Description Table APIC structure types	309	// Multiple APIC Description Table APIC structure types
Lines 325-381 typedef struct { Link Here
325	/// Processor Local APIC Structure Definition	335	/// Processor Local APIC Structure Definition
326	///	336	///
327	typedef struct {	337	typedef struct {
328	UINT8 Type;	338	UINT8 Type;
329	UINT8 Length;	339	UINT8 Length;
330	UINT8 AcpiProcessorUid;	340	UINT8 AcpiProcessorUid;
331	UINT8 ApicId;	341	UINT8 ApicId;
332	UINT32 Flags;	342	UINT32 Flags;
333	} EFI_ACPI_6_0_PROCESSOR_LOCAL_APIC_STRUCTURE;	343	} EFI_ACPI_6_0_PROCESSOR_LOCAL_APIC_STRUCTURE;
334		344
335	///	345	///
336	/// Local APIC Flags. All other bits are reserved and must be 0.	346	/// Local APIC Flags. All other bits are reserved and must be 0.
337	///	347	///
338	#define EFI_ACPI_6_0_LOCAL_APIC_ENABLED BIT0	348	#define EFI_ACPI_6_0_LOCAL_APIC_ENABLED BIT0
339		349
340	///	350	///
341	/// IO APIC Structure	351	/// IO APIC Structure
342	///	352	///
343	typedef struct {	353	typedef struct {
344	UINT8 Type;	354	UINT8 Type;
345	UINT8 Length;	355	UINT8 Length;
346	UINT8 IoApicId;	356	UINT8 IoApicId;
347	UINT8 Reserved;	357	UINT8 Reserved;
348	UINT32 IoApicAddress;	358	UINT32 IoApicAddress;
349	UINT32 GlobalSystemInterruptBase;	359	UINT32 GlobalSystemInterruptBase;
350	} EFI_ACPI_6_0_IO_APIC_STRUCTURE;	360	} EFI_ACPI_6_0_IO_APIC_STRUCTURE;
351		361
352	///	362	///
353	/// Interrupt Source Override Structure	363	/// Interrupt Source Override Structure
354	///	364	///
355	typedef struct {	365	typedef struct {
356	UINT8 Type;	366	UINT8 Type;
357	UINT8 Length;	367	UINT8 Length;
358	UINT8 Bus;	368	UINT8 Bus;
359	UINT8 Source;	369	UINT8 Source;
360	UINT32 GlobalSystemInterrupt;	370	UINT32 GlobalSystemInterrupt;
361	UINT16 Flags;	371	UINT16 Flags;
362	} EFI_ACPI_6_0_INTERRUPT_SOURCE_OVERRIDE_STRUCTURE;	372	} EFI_ACPI_6_0_INTERRUPT_SOURCE_OVERRIDE_STRUCTURE;
363		373
364	///	374	///
365	/// Platform Interrupt Sources Structure Definition	375	/// Platform Interrupt Sources Structure Definition
366	///	376	///
367	typedef struct {	377	typedef struct {
368	UINT8 Type;	378	UINT8 Type;
369	UINT8 Length;	379	UINT8 Length;
370	UINT16 Flags;	380	UINT16 Flags;
371	UINT8 InterruptType;	381	UINT8 InterruptType;
372	UINT8 ProcessorId;	382	UINT8 ProcessorId;
373	UINT8 ProcessorEid;	383	UINT8 ProcessorEid;
374	UINT8 IoSapicVector;	384	UINT8 IoSapicVector;
375	UINT32 GlobalSystemInterrupt;	385	UINT32 GlobalSystemInterrupt;
376	UINT32 PlatformInterruptSourceFlags;	386	UINT32 PlatformInterruptSourceFlags;
377	UINT8 CpeiProcessorOverride;	387	UINT8 CpeiProcessorOverride;
378	UINT8 Reserved[31];	388	UINT8 Reserved[31];
379	} EFI_ACPI_6_0_PLATFORM_INTERRUPT_APIC_STRUCTURE;	389	} EFI_ACPI_6_0_PLATFORM_INTERRUPT_APIC_STRUCTURE;
380		390
381	//	391	//
Lines 389-431 typedef struct { Link Here
389	/// Non-Maskable Interrupt Source Structure	399	/// Non-Maskable Interrupt Source Structure
390	///	400	///
391	typedef struct {	401	typedef struct {
392	UINT8 Type;	402	UINT8 Type;
393	UINT8 Length;	403	UINT8 Length;
394	UINT16 Flags;	404	UINT16 Flags;
395	UINT32 GlobalSystemInterrupt;	405	UINT32 GlobalSystemInterrupt;
396	} EFI_ACPI_6_0_NON_MASKABLE_INTERRUPT_SOURCE_STRUCTURE;	406	} EFI_ACPI_6_0_NON_MASKABLE_INTERRUPT_SOURCE_STRUCTURE;
397		407
398	///	408	///
399	/// Local APIC NMI Structure	409	/// Local APIC NMI Structure
400	///	410	///
401	typedef struct {	411	typedef struct {
402	UINT8 Type;	412	UINT8 Type;
403	UINT8 Length;	413	UINT8 Length;
404	UINT8 AcpiProcessorUid;	414	UINT8 AcpiProcessorUid;
405	UINT16 Flags;	415	UINT16 Flags;
406	UINT8 LocalApicLint;	416	UINT8 LocalApicLint;
407	} EFI_ACPI_6_0_LOCAL_APIC_NMI_STRUCTURE;	417	} EFI_ACPI_6_0_LOCAL_APIC_NMI_STRUCTURE;
408		418
409	///	419	///
410	/// Local APIC Address Override Structure	420	/// Local APIC Address Override Structure
411	///	421	///
412	typedef struct {	422	typedef struct {
413	UINT8 Type;	423	UINT8 Type;
414	UINT8 Length;	424	UINT8 Length;
415	UINT16 Reserved;	425	UINT16 Reserved;
416	UINT64 LocalApicAddress;	426	UINT64 LocalApicAddress;
417	} EFI_ACPI_6_0_LOCAL_APIC_ADDRESS_OVERRIDE_STRUCTURE;	427	} EFI_ACPI_6_0_LOCAL_APIC_ADDRESS_OVERRIDE_STRUCTURE;
418		428
419	///	429	///
420	/// IO SAPIC Structure	430	/// IO SAPIC Structure
421	///	431	///
422	typedef struct {	432	typedef struct {
423	UINT8 Type;	433	UINT8 Type;
424	UINT8 Length;	434	UINT8 Length;
425	UINT8 IoApicId;	435	UINT8 IoApicId;
426	UINT8 Reserved;	436	UINT8 Reserved;
427	UINT32 GlobalSystemInterruptBase;	437	UINT32 GlobalSystemInterruptBase;
428	UINT64 IoSapicAddress;	438	UINT64 IoSapicAddress;
429	} EFI_ACPI_6_0_IO_SAPIC_STRUCTURE;	439	} EFI_ACPI_6_0_IO_SAPIC_STRUCTURE;
430		440
431	///	441	///
Lines 433-601 typedef struct { Link Here
433	/// This struct followed by a null-terminated ASCII string - ACPI Processor UID String	443	/// This struct followed by a null-terminated ASCII string - ACPI Processor UID String
434	///	444	///
435	typedef struct {	445	typedef struct {
436	UINT8 Type;	446	UINT8 Type;
437	UINT8 Length;	447	UINT8 Length;
438	UINT8 AcpiProcessorId;	448	UINT8 AcpiProcessorId;
439	UINT8 LocalSapicId;	449	UINT8 LocalSapicId;
440	UINT8 LocalSapicEid;	450	UINT8 LocalSapicEid;
441	UINT8 Reserved[3];	451	UINT8 Reserved[3];
442	UINT32 Flags;	452	UINT32 Flags;
443	UINT32 ACPIProcessorUIDValue;	453	UINT32 ACPIProcessorUIDValue;
444	} EFI_ACPI_6_0_PROCESSOR_LOCAL_SAPIC_STRUCTURE;	454	} EFI_ACPI_6_0_PROCESSOR_LOCAL_SAPIC_STRUCTURE;
445		455
446	///	456	///
447	/// Platform Interrupt Sources Structure	457	/// Platform Interrupt Sources Structure
448	///	458	///
449	typedef struct {	459	typedef struct {
450	UINT8 Type;	460	UINT8 Type;
451	UINT8 Length;	461	UINT8 Length;
452	UINT16 Flags;	462	UINT16 Flags;
453	UINT8 InterruptType;	463	UINT8 InterruptType;
454	UINT8 ProcessorId;	464	UINT8 ProcessorId;
455	UINT8 ProcessorEid;	465	UINT8 ProcessorEid;
456	UINT8 IoSapicVector;	466	UINT8 IoSapicVector;
457	UINT32 GlobalSystemInterrupt;	467	UINT32 GlobalSystemInterrupt;
458	UINT32 PlatformInterruptSourceFlags;	468	UINT32 PlatformInterruptSourceFlags;
459	} EFI_ACPI_6_0_PLATFORM_INTERRUPT_SOURCES_STRUCTURE;	469	} EFI_ACPI_6_0_PLATFORM_INTERRUPT_SOURCES_STRUCTURE;
460		470
461	///	471	///
462	/// Platform Interrupt Source Flags.	472	/// Platform Interrupt Source Flags.
463	/// All other bits are reserved and must be set to 0.	473	/// All other bits are reserved and must be set to 0.
464	///	474	///
465	#define EFI_ACPI_6_0_CPEI_PROCESSOR_OVERRIDE BIT0	475	#define EFI_ACPI_6_0_CPEI_PROCESSOR_OVERRIDE BIT0
466		476
467	///	477	///
468	/// Processor Local x2APIC Structure Definition	478	/// Processor Local x2APIC Structure Definition
469	///	479	///
470	typedef struct {	480	typedef struct {
471	UINT8 Type;	481	UINT8 Type;
472	UINT8 Length;	482	UINT8 Length;
473	UINT8 Reserved[2];	483	UINT8 Reserved[2];
474	UINT32 X2ApicId;	484	UINT32 X2ApicId;
475	UINT32 Flags;	485	UINT32 Flags;
476	UINT32 AcpiProcessorUid;	486	UINT32 AcpiProcessorUid;
477	} EFI_ACPI_6_0_PROCESSOR_LOCAL_X2APIC_STRUCTURE;	487	} EFI_ACPI_6_0_PROCESSOR_LOCAL_X2APIC_STRUCTURE;
478		488
479	///	489	///
480	/// Local x2APIC NMI Structure	490	/// Local x2APIC NMI Structure
481	///	491	///
482	typedef struct {	492	typedef struct {
483	UINT8 Type;	493	UINT8 Type;
484	UINT8 Length;	494	UINT8 Length;
485	UINT16 Flags;	495	UINT16 Flags;
486	UINT32 AcpiProcessorUid;	496	UINT32 AcpiProcessorUid;
487	UINT8 LocalX2ApicLint;	497	UINT8 LocalX2ApicLint;
488	UINT8 Reserved[3];	498	UINT8 Reserved[3];
489	} EFI_ACPI_6_0_LOCAL_X2APIC_NMI_STRUCTURE;	499	} EFI_ACPI_6_0_LOCAL_X2APIC_NMI_STRUCTURE;
490		500
491	///	501	///
492	/// GIC Structure	502	/// GIC Structure
493	///	503	///
494	typedef struct {	504	typedef struct {
495	UINT8 Type;	505	UINT8 Type;
496	UINT8 Length;	506	UINT8 Length;
497	UINT16 Reserved;	507	UINT16 Reserved;
498	UINT32 CPUInterfaceNumber;	508	UINT32 CPUInterfaceNumber;
499	UINT32 AcpiProcessorUid;	509	UINT32 AcpiProcessorUid;
500	UINT32 Flags;	510	UINT32 Flags;
501	UINT32 ParkingProtocolVersion;	511	UINT32 ParkingProtocolVersion;
502	UINT32 PerformanceInterruptGsiv;	512	UINT32 PerformanceInterruptGsiv;
503	UINT64 ParkedAddress;	513	UINT64 ParkedAddress;
504	UINT64 PhysicalBaseAddress;	514	UINT64 PhysicalBaseAddress;
505	UINT64 GICV;	515	UINT64 GICV;
506	UINT64 GICH;	516	UINT64 GICH;
507	UINT32 VGICMaintenanceInterrupt;	517	UINT32 VGICMaintenanceInterrupt;
508	UINT64 GICRBaseAddress;	518	UINT64 GICRBaseAddress;
509	UINT64 MPIDR;	519	UINT64 MPIDR;
510	UINT8 ProcessorPowerEfficiencyClass;	520	UINT8 ProcessorPowerEfficiencyClass;
511	UINT8 Reserved2[3];	521	UINT8 Reserved2[3];
512	} EFI_ACPI_6_0_GIC_STRUCTURE;	522	} EFI_ACPI_6_0_GIC_STRUCTURE;
513		523
514	///	524	///
515	/// GIC Flags. All other bits are reserved and must be 0.	525	/// GIC Flags. All other bits are reserved and must be 0.
516	///	526	///
517	#define EFI_ACPI_6_0_GIC_ENABLED BIT0	527	#define EFI_ACPI_6_0_GIC_ENABLED BIT0
518	#define EFI_ACPI_6_0_PERFORMANCE_INTERRUPT_MODEL BIT1	528	#define EFI_ACPI_6_0_PERFORMANCE_INTERRUPT_MODEL BIT1
519	#define EFI_ACPI_6_0_VGIC_MAINTENANCE_INTERRUPT_MODE_FLAGS BIT2	529	#define EFI_ACPI_6_0_VGIC_MAINTENANCE_INTERRUPT_MODE_FLAGS BIT2
520		530
521	///	531	///
522	/// GIC Distributor Structure	532	/// GIC Distributor Structure
523	///	533	///
524	typedef struct {	534	typedef struct {
525	UINT8 Type;	535	UINT8 Type;
526	UINT8 Length;	536	UINT8 Length;
527	UINT16 Reserved1;	537	UINT16 Reserved1;
528	UINT32 GicId;	538	UINT32 GicId;
529	UINT64 PhysicalBaseAddress;	539	UINT64 PhysicalBaseAddress;
530	UINT32 SystemVectorBase;	540	UINT32 SystemVectorBase;
531	UINT8 GicVersion;	541	UINT8 GicVersion;
532	UINT8 Reserved2[3];	542	UINT8 Reserved2[3];
533	} EFI_ACPI_6_0_GIC_DISTRIBUTOR_STRUCTURE;	543	} EFI_ACPI_6_0_GIC_DISTRIBUTOR_STRUCTURE;
534		544
535	///	545	///
536	/// GIC Version	546	/// GIC Version
537	///	547	///
538	#define EFI_ACPI_6_0_GIC_V1 0x01	548	#define EFI_ACPI_6_0_GIC_V1 0x01
539	#define EFI_ACPI_6_0_GIC_V2 0x02	549	#define EFI_ACPI_6_0_GIC_V2 0x02
540	#define EFI_ACPI_6_0_GIC_V3 0x03	550	#define EFI_ACPI_6_0_GIC_V3 0x03
541	#define EFI_ACPI_6_0_GIC_V4 0x04	551	#define EFI_ACPI_6_0_GIC_V4 0x04
542		552
543	///	553	///
544	/// GIC MSI Frame Structure	554	/// GIC MSI Frame Structure
545	///	555	///
546	typedef struct {	556	typedef struct {
547	UINT8 Type;	557	UINT8 Type;
548	UINT8 Length;	558	UINT8 Length;
549	UINT16 Reserved1;	559	UINT16 Reserved1;
550	UINT32 GicMsiFrameId;	560	UINT32 GicMsiFrameId;
551	UINT64 PhysicalBaseAddress;	561	UINT64 PhysicalBaseAddress;
552	UINT32 Flags;	562	UINT32 Flags;
553	UINT16 SPICount;	563	UINT16 SPICount;
554	UINT16 SPIBase;	564	UINT16 SPIBase;
555	} EFI_ACPI_6_0_GIC_MSI_FRAME_STRUCTURE;	565	} EFI_ACPI_6_0_GIC_MSI_FRAME_STRUCTURE;
556		566
557	///	567	///
558	/// GIC MSI Frame Flags. All other bits are reserved and must be 0.	568	/// GIC MSI Frame Flags. All other bits are reserved and must be 0.
559	///	569	///
560	#define EFI_ACPI_6_0_SPI_COUNT_BASE_SELECT BIT0	570	#define EFI_ACPI_6_0_SPI_COUNT_BASE_SELECT BIT0
561		571
562	///	572	///
563	/// GICR Structure	573	/// GICR Structure
564	///	574	///
565	typedef struct {	575	typedef struct {
566	UINT8 Type;	576	UINT8 Type;
567	UINT8 Length;	577	UINT8 Length;
568	UINT16 Reserved;	578	UINT16 Reserved;
569	UINT64 DiscoveryRangeBaseAddress;	579	UINT64 DiscoveryRangeBaseAddress;
570	UINT32 DiscoveryRangeLength;	580	UINT32 DiscoveryRangeLength;
571	} EFI_ACPI_6_0_GICR_STRUCTURE;	581	} EFI_ACPI_6_0_GICR_STRUCTURE;
572		582
573	///	583	///
574	/// GIC Interrupt Translation Service Structure	584	/// GIC Interrupt Translation Service Structure
575	///	585	///
576	typedef struct {	586	typedef struct {
577	UINT8 Type;	587	UINT8 Type;
578	UINT8 Length;	588	UINT8 Length;
579	UINT16 Reserved;	589	UINT16 Reserved;
580	UINT32 GicItsId;	590	UINT32 GicItsId;
581	UINT64 PhysicalBaseAddress;	591	UINT64 PhysicalBaseAddress;
582	UINT32 Reserved2;	592	UINT32 Reserved2;
583	} EFI_ACPI_6_0_GIC_ITS_STRUCTURE;	593	} EFI_ACPI_6_0_GIC_ITS_STRUCTURE;
584		594
585	///	595	///
586	/// Smart Battery Description Table (SBST)	596	/// Smart Battery Description Table (SBST)
587	///	597	///
588	typedef struct {	598	typedef struct {
589	EFI_ACPI_DESCRIPTION_HEADER Header;	599	EFI_ACPI_DESCRIPTION_HEADER Header;
590	UINT32 WarningEnergyLevel;	600	UINT32 WarningEnergyLevel;
591	UINT32 LowEnergyLevel;	601	UINT32 LowEnergyLevel;
592	UINT32 CriticalEnergyLevel;	602	UINT32 CriticalEnergyLevel;
593	} EFI_ACPI_6_0_SMART_BATTERY_DESCRIPTION_TABLE;	603	} EFI_ACPI_6_0_SMART_BATTERY_DESCRIPTION_TABLE;
594		604
595	///	605	///
596	/// SBST Version (as defined in ACPI 6.0 spec.)	606	/// SBST Version (as defined in ACPI 6.0 spec.)
597	///	607	///
598	#define EFI_ACPI_6_0_SMART_BATTERY_DESCRIPTION_TABLE_REVISION 0x01	608	#define EFI_ACPI_6_0_SMART_BATTERY_DESCRIPTION_TABLE_REVISION 0x01
599		609
600	///	610	///
601	/// Embedded Controller Boot Resources Table (ECDT)	611	/// Embedded Controller Boot Resources Table (ECDT)
Lines 603-613 typedef struct { Link Here
603	/// a fully qualified reference to the name space object.	613	/// a fully qualified reference to the name space object.
604	///	614	///
605	typedef struct {	615	typedef struct {
606	EFI_ACPI_DESCRIPTION_HEADER Header;	616	EFI_ACPI_DESCRIPTION_HEADER Header;
607	EFI_ACPI_6_0_GENERIC_ADDRESS_STRUCTURE EcControl;	617	EFI_ACPI_6_0_GENERIC_ADDRESS_STRUCTURE EcControl;
608	EFI_ACPI_6_0_GENERIC_ADDRESS_STRUCTURE EcData;	618	EFI_ACPI_6_0_GENERIC_ADDRESS_STRUCTURE EcData;
609	UINT32 Uid;	619	UINT32 Uid;
610	UINT8 GpeBit;	620	UINT8 GpeBit;
611	} EFI_ACPI_6_0_EMBEDDED_CONTROLLER_BOOT_RESOURCES_TABLE;	621	} EFI_ACPI_6_0_EMBEDDED_CONTROLLER_BOOT_RESOURCES_TABLE;
612		622
613	///	623	///
Lines 620-628 typedef struct { Link Here
620	/// must be defined in a platform specific manner.	630	/// must be defined in a platform specific manner.
621	///	631	///
622	typedef struct {	632	typedef struct {
623	EFI_ACPI_DESCRIPTION_HEADER Header;	633	EFI_ACPI_DESCRIPTION_HEADER Header;
624	UINT32 Reserved1; ///< Must be set to 1	634	UINT32 Reserved1; ///< Must be set to 1
625	UINT64 Reserved2;	635	UINT64 Reserved2;
626	} EFI_ACPI_6_0_SYSTEM_RESOURCE_AFFINITY_TABLE_HEADER;	636	} EFI_ACPI_6_0_SYSTEM_RESOURCE_AFFINITY_TABLE_HEADER;
627		637
628	///	638	///
Lines 644-726 typedef struct { Link Here
644	/// Processor Local APIC/SAPIC Affinity Structure Definition	654	/// Processor Local APIC/SAPIC Affinity Structure Definition
645	///	655	///
646	typedef struct {	656	typedef struct {
647	UINT8 Type;	657	UINT8 Type;
648	UINT8 Length;	658	UINT8 Length;
649	UINT8 ProximityDomain7To0;	659	UINT8 ProximityDomain7To0;
650	UINT8 ApicId;	660	UINT8 ApicId;
651	UINT32 Flags;	661	UINT32 Flags;
652	UINT8 LocalSapicEid;	662	UINT8 LocalSapicEid;
653	UINT8 ProximityDomain31To8[3];	663	UINT8 ProximityDomain31To8[3];
654	UINT32 ClockDomain;	664	UINT32 ClockDomain;
655	} EFI_ACPI_6_0_PROCESSOR_LOCAL_APIC_SAPIC_AFFINITY_STRUCTURE;	665	} EFI_ACPI_6_0_PROCESSOR_LOCAL_APIC_SAPIC_AFFINITY_STRUCTURE;
656		666
657	///	667	///
658	/// Local APIC/SAPIC Flags. All other bits are reserved and must be 0.	668	/// Local APIC/SAPIC Flags. All other bits are reserved and must be 0.
659	///	669	///
660	#define EFI_ACPI_6_0_PROCESSOR_LOCAL_APIC_SAPIC_ENABLED (1 << 0)	670	#define EFI_ACPI_6_0_PROCESSOR_LOCAL_APIC_SAPIC_ENABLED (1 << 0)
661		671
662	///	672	///
663	/// Memory Affinity Structure Definition	673	/// Memory Affinity Structure Definition
664	///	674	///
665	typedef struct {	675	typedef struct {
666	UINT8 Type;	676	UINT8 Type;
667	UINT8 Length;	677	UINT8 Length;
668	UINT32 ProximityDomain;	678	UINT32 ProximityDomain;
669	UINT16 Reserved1;	679	UINT16 Reserved1;
670	UINT32 AddressBaseLow;	680	UINT32 AddressBaseLow;
671	UINT32 AddressBaseHigh;	681	UINT32 AddressBaseHigh;
672	UINT32 LengthLow;	682	UINT32 LengthLow;
673	UINT32 LengthHigh;	683	UINT32 LengthHigh;
674	UINT32 Reserved2;	684	UINT32 Reserved2;
675	UINT32 Flags;	685	UINT32 Flags;
676	UINT64 Reserved3;	686	UINT64 Reserved3;
677	} EFI_ACPI_6_0_MEMORY_AFFINITY_STRUCTURE;	687	} EFI_ACPI_6_0_MEMORY_AFFINITY_STRUCTURE;
678		688
679	//	689	//
680	// Memory Flags. All other bits are reserved and must be 0.	690	// Memory Flags. All other bits are reserved and must be 0.
681	//	691	//
682	#define EFI_ACPI_6_0_MEMORY_ENABLED (1 << 0)	692	#define EFI_ACPI_6_0_MEMORY_ENABLED (1 << 0)
683	#define EFI_ACPI_6_0_MEMORY_HOT_PLUGGABLE (1 << 1)	693	#define EFI_ACPI_6_0_MEMORY_HOT_PLUGGABLE (1 << 1)
684	#define EFI_ACPI_6_0_MEMORY_NONVOLATILE (1 << 2)	694	#define EFI_ACPI_6_0_MEMORY_NONVOLATILE (1 << 2)
685		695
686	///	696	///
687	/// Processor Local x2APIC Affinity Structure Definition	697	/// Processor Local x2APIC Affinity Structure Definition
688	///	698	///
689	typedef struct {	699	typedef struct {
690	UINT8 Type;	700	UINT8 Type;
691	UINT8 Length;	701	UINT8 Length;
692	UINT8 Reserved1[2];	702	UINT8 Reserved1[2];
693	UINT32 ProximityDomain;	703	UINT32 ProximityDomain;
694	UINT32 X2ApicId;	704	UINT32 X2ApicId;
695	UINT32 Flags;	705	UINT32 Flags;
696	UINT32 ClockDomain;	706	UINT32 ClockDomain;
697	UINT8 Reserved2[4];	707	UINT8 Reserved2[4];
698	} EFI_ACPI_6_0_PROCESSOR_LOCAL_X2APIC_AFFINITY_STRUCTURE;	708	} EFI_ACPI_6_0_PROCESSOR_LOCAL_X2APIC_AFFINITY_STRUCTURE;
699		709
700	///	710	///
701	/// GICC Affinity Structure Definition	711	/// GICC Affinity Structure Definition
702	///	712	///
703	typedef struct {	713	typedef struct {
704	UINT8 Type;	714	UINT8 Type;
705	UINT8 Length;	715	UINT8 Length;
706	UINT32 ProximityDomain;	716	UINT32 ProximityDomain;
707	UINT32 AcpiProcessorUid;	717	UINT32 AcpiProcessorUid;
708	UINT32 Flags;	718	UINT32 Flags;
709	UINT32 ClockDomain;	719	UINT32 ClockDomain;
710	} EFI_ACPI_6_0_GICC_AFFINITY_STRUCTURE;	720	} EFI_ACPI_6_0_GICC_AFFINITY_STRUCTURE;
711		721
712	///	722	///
713	/// GICC Flags. All other bits are reserved and must be 0.	723	/// GICC Flags. All other bits are reserved and must be 0.
714	///	724	///
715	#define EFI_ACPI_6_0_GICC_ENABLED (1 << 0)	725	#define EFI_ACPI_6_0_GICC_ENABLED (1 << 0)
716		726
717	///	727	///
718	/// System Locality Distance Information Table (SLIT).	728	/// System Locality Distance Information Table (SLIT).
719	/// The rest of the table is a matrix.	729	/// The rest of the table is a matrix.
720	///	730	///
721	typedef struct {	731	typedef struct {
722	EFI_ACPI_DESCRIPTION_HEADER Header;	732	EFI_ACPI_DESCRIPTION_HEADER Header;
723	UINT64 NumberOfSystemLocalities;	733	UINT64 NumberOfSystemLocalities;
724	} EFI_ACPI_6_0_SYSTEM_LOCALITY_DISTANCE_INFORMATION_TABLE_HEADER;	734	} EFI_ACPI_6_0_SYSTEM_LOCALITY_DISTANCE_INFORMATION_TABLE_HEADER;
725		735
726	///	736	///
Lines 732-745 typedef struct { Link Here
732	/// Corrected Platform Error Polling Table (CPEP)	742	/// Corrected Platform Error Polling Table (CPEP)
733	///	743	///
734	typedef struct {	744	typedef struct {
735	EFI_ACPI_DESCRIPTION_HEADER Header;	745	EFI_ACPI_DESCRIPTION_HEADER Header;
736	UINT8 Reserved[8];	746	UINT8 Reserved[8];
737	} EFI_ACPI_6_0_CORRECTED_PLATFORM_ERROR_POLLING_TABLE_HEADER;	747	} EFI_ACPI_6_0_CORRECTED_PLATFORM_ERROR_POLLING_TABLE_HEADER;
738		748
739	///	749	///
740	/// CPEP Version (as defined in ACPI 6.0 spec.)	750	/// CPEP Version (as defined in ACPI 6.0 spec.)
741	///	751	///
742	#define EFI_ACPI_6_0_CORRECTED_PLATFORM_ERROR_POLLING_TABLE_REVISION 0x01	752	#define EFI_ACPI_6_0_CORRECTED_PLATFORM_ERROR_POLLING_TABLE_REVISION 0x01
743		753
744	//	754	//
745	// CPEP processor structure types.	755	// CPEP processor structure types.
Lines 750-815 typedef struct { Link Here
750	/// Corrected Platform Error Polling Processor Structure Definition	760	/// Corrected Platform Error Polling Processor Structure Definition
751	///	761	///
752	typedef struct {	762	typedef struct {
753	UINT8 Type;	763	UINT8 Type;
754	UINT8 Length;	764	UINT8 Length;
755	UINT8 ProcessorId;	765	UINT8 ProcessorId;
756	UINT8 ProcessorEid;	766	UINT8 ProcessorEid;
757	UINT32 PollingInterval;	767	UINT32 PollingInterval;
758	} EFI_ACPI_6_0_CPEP_PROCESSOR_APIC_SAPIC_STRUCTURE;	768	} EFI_ACPI_6_0_CPEP_PROCESSOR_APIC_SAPIC_STRUCTURE;
759		769
760	///	770	///
761	/// Maximum System Characteristics Table (MSCT)	771	/// Maximum System Characteristics Table (MSCT)
762	///	772	///
763	typedef struct {	773	typedef struct {
764	EFI_ACPI_DESCRIPTION_HEADER Header;	774	EFI_ACPI_DESCRIPTION_HEADER Header;
765	UINT32 OffsetProxDomInfo;	775	UINT32 OffsetProxDomInfo;
766	UINT32 MaximumNumberOfProximityDomains;	776	UINT32 MaximumNumberOfProximityDomains;
767	UINT32 MaximumNumberOfClockDomains;	777	UINT32 MaximumNumberOfClockDomains;
768	UINT64 MaximumPhysicalAddress;	778	UINT64 MaximumPhysicalAddress;
769	} EFI_ACPI_6_0_MAXIMUM_SYSTEM_CHARACTERISTICS_TABLE_HEADER;	779	} EFI_ACPI_6_0_MAXIMUM_SYSTEM_CHARACTERISTICS_TABLE_HEADER;
770		780
771	///	781	///
772	/// MSCT Version (as defined in ACPI 6.0 spec.)	782	/// MSCT Version (as defined in ACPI 6.0 spec.)
773	///	783	///
774	#define EFI_ACPI_6_0_MAXIMUM_SYSTEM_CHARACTERISTICS_TABLE_REVISION 0x01	784	#define EFI_ACPI_6_0_MAXIMUM_SYSTEM_CHARACTERISTICS_TABLE_REVISION 0x01
775		785
776	///	786	///
777	/// Maximum Proximity Domain Information Structure Definition	787	/// Maximum Proximity Domain Information Structure Definition
778	///	788	///
779	typedef struct {	789	typedef struct {
780	UINT8 Revision;	790	UINT8 Revision;
781	UINT8 Length;	791	UINT8 Length;
782	UINT32 ProximityDomainRangeLow;	792	UINT32 ProximityDomainRangeLow;
783	UINT32 ProximityDomainRangeHigh;	793	UINT32 ProximityDomainRangeHigh;
784	UINT32 MaximumProcessorCapacity;	794	UINT32 MaximumProcessorCapacity;
785	UINT64 MaximumMemoryCapacity;	795	UINT64 MaximumMemoryCapacity;
786	} EFI_ACPI_6_0_MAXIMUM_PROXIMITY_DOMAIN_INFORMATION_STRUCTURE;	796	} EFI_ACPI_6_0_MAXIMUM_PROXIMITY_DOMAIN_INFORMATION_STRUCTURE;
787		797
788	///	798	///
789	/// ACPI RAS Feature Table definition.	799	/// ACPI RAS Feature Table definition.
790	///	800	///
791	typedef struct {	801	typedef struct {
792	EFI_ACPI_DESCRIPTION_HEADER Header;	802	EFI_ACPI_DESCRIPTION_HEADER Header;
793	UINT8 PlatformCommunicationChannelIdentifier[12];	803	UINT8 PlatformCommunicationChannelIdentifier[12];
794	} EFI_ACPI_6_0_RAS_FEATURE_TABLE;	804	} EFI_ACPI_6_0_RAS_FEATURE_TABLE;
795		805
796	///	806	///
797	/// RASF Version (as defined in ACPI 6.0 spec.)	807	/// RASF Version (as defined in ACPI 6.0 spec.)
798	///	808	///
799	#define EFI_ACPI_6_0_RAS_FEATURE_TABLE_REVISION 0x01	809	#define EFI_ACPI_6_0_RAS_FEATURE_TABLE_REVISION 0x01
800		810
801	///	811	///
802	/// ACPI RASF Platform Communication Channel Shared Memory Region definition.	812	/// ACPI RASF Platform Communication Channel Shared Memory Region definition.
803	///	813	///
804	typedef struct {	814	typedef struct {
805	UINT32 Signature;	815	UINT32 Signature;
806	UINT16 Command;	816	UINT16 Command;
807	UINT16 Status;	817	UINT16 Status;
808	UINT16 Version;	818	UINT16 Version;
809	UINT8 RASCapabilities[16];	819	UINT8 RASCapabilities[16];
810	UINT8 SetRASCapabilities[16];	820	UINT8 SetRASCapabilities[16];
811	UINT16 NumberOfRASFParameterBlocks;	821	UINT16 NumberOfRASFParameterBlocks;
812	UINT32 SetRASCapabilitiesStatus;	822	UINT32 SetRASCapabilitiesStatus;
813	} EFI_ACPI_6_0_RASF_PLATFORM_COMMUNICATION_CHANNEL_SHARED_MEMORY_REGION;	823	} EFI_ACPI_6_0_RASF_PLATFORM_COMMUNICATION_CHANNEL_SHARED_MEMORY_REGION;
814		824
815	///	825	///
Lines 827-878 typedef struct { Link Here
827	/// ACPI RASF Parameter Block structure for PATROL_SCRUB	837	/// ACPI RASF Parameter Block structure for PATROL_SCRUB
828	///	838	///
829	typedef struct {	839	typedef struct {
830	UINT16 Type;	840	UINT16 Type;
831	UINT16 Version;	841	UINT16 Version;
832	UINT16 Length;	842	UINT16 Length;
833	UINT16 PatrolScrubCommand;	843	UINT16 PatrolScrubCommand;
834	UINT64 RequestedAddressRange[2];	844	UINT64 RequestedAddressRange[2];
835	UINT64 ActualAddressRange[2];	845	UINT64 ActualAddressRange[2];
836	UINT16 Flags;	846	UINT16 Flags;
837	UINT8 RequestedSpeed;	847	UINT8 RequestedSpeed;
838	} EFI_ACPI_6_0_RASF_PATROL_SCRUB_PLATFORM_BLOCK_STRUCTURE;	848	} EFI_ACPI_6_0_RASF_PATROL_SCRUB_PLATFORM_BLOCK_STRUCTURE;
839		849
840	///	850	///
841	/// ACPI RASF Patrol Scrub command	851	/// ACPI RASF Patrol Scrub command
842	///	852	///
843	#define EFI_ACPI_6_0_RASF_PATROL_SCRUB_COMMAND_GET_PATROL_PARAMETERS 0x01	853	#define EFI_ACPI_6_0_RASF_PATROL_SCRUB_COMMAND_GET_PATROL_PARAMETERS 0x01
844	#define EFI_ACPI_6_0_RASF_PATROL_SCRUB_COMMAND_START_PATROL_SCRUBBER 0x02	854	#define EFI_ACPI_6_0_RASF_PATROL_SCRUB_COMMAND_START_PATROL_SCRUBBER 0x02
845	#define EFI_ACPI_6_0_RASF_PATROL_SCRUB_COMMAND_STOP_PATROL_SCRUBBER 0x03	855	#define EFI_ACPI_6_0_RASF_PATROL_SCRUB_COMMAND_STOP_PATROL_SCRUBBER 0x03
846		856
847	///	857	///
848	/// Memory Power State Table definition.	858	/// Memory Power State Table definition.
849	///	859	///
850	typedef struct {	860	typedef struct {
851	EFI_ACPI_DESCRIPTION_HEADER Header;	861	EFI_ACPI_DESCRIPTION_HEADER Header;
852	UINT8 PlatformCommunicationChannelIdentifier;	862	UINT8 PlatformCommunicationChannelIdentifier;
853	UINT8 Reserved[3];	863	UINT8 Reserved[3];
854	// Memory Power Node Structure	864	// Memory Power Node Structure
855	// Memory Power State Characteristics	865	// Memory Power State Characteristics
856	} EFI_ACPI_6_0_MEMORY_POWER_STATUS_TABLE;	866	} EFI_ACPI_6_0_MEMORY_POWER_STATUS_TABLE;
857		867
858	///	868	///
859	/// MPST Version (as defined in ACPI 6.0 spec.)	869	/// MPST Version (as defined in ACPI 6.0 spec.)
860	///	870	///
861	#define EFI_ACPI_6_0_MEMORY_POWER_STATE_TABLE_REVISION 0x01	871	#define EFI_ACPI_6_0_MEMORY_POWER_STATE_TABLE_REVISION 0x01
862		872
863	///	873	///
864	/// MPST Platform Communication Channel Shared Memory Region definition.	874	/// MPST Platform Communication Channel Shared Memory Region definition.
865	///	875	///
866	typedef struct {	876	typedef struct {
867	UINT32 Signature;	877	UINT32 Signature;
868	UINT16 Command;	878	UINT16 Command;
869	UINT16 Status;	879	UINT16 Status;
870	UINT32 MemoryPowerCommandRegister;	880	UINT32 MemoryPowerCommandRegister;
871	UINT32 MemoryPowerStatusRegister;	881	UINT32 MemoryPowerStatusRegister;
872	UINT32 PowerStateId;	882	UINT32 PowerStateId;
873	UINT32 MemoryPowerNodeId;	883	UINT32 MemoryPowerNodeId;
874	UINT64 MemoryEnergyConsumed;	884	UINT64 MemoryEnergyConsumed;
875	UINT64 ExpectedAveragePowerComsuned;	885	UINT64 ExpectedAveragePowerComsuned;
876	} EFI_ACPI_6_0_MPST_PLATFORM_COMMUNICATION_CHANNEL_SHARED_MEMORY_REGION;	886	} EFI_ACPI_6_0_MPST_PLATFORM_COMMUNICATION_CHANNEL_SHARED_MEMORY_REGION;
877		887
878	///	888	///
Lines 883-1068 typedef struct { Link Here
883	///	893	///
884	/// ACPI MPST Memory Power command	894	/// ACPI MPST Memory Power command
885	///	895	///
886	#define EFI_ACPI_6_0_MPST_MEMORY_POWER_COMMAND_GET_MEMORY_POWER_STATE 0x01	896	#define EFI_ACPI_6_0_MPST_MEMORY_POWER_COMMAND_GET_MEMORY_POWER_STATE 0x01
887	#define EFI_ACPI_6_0_MPST_MEMORY_POWER_COMMAND_SET_MEMORY_POWER_STATE 0x02	897	#define EFI_ACPI_6_0_MPST_MEMORY_POWER_COMMAND_SET_MEMORY_POWER_STATE 0x02
888	#define EFI_ACPI_6_0_MPST_MEMORY_POWER_COMMAND_GET_AVERAGE_POWER_CONSUMED 0x03	898	#define EFI_ACPI_6_0_MPST_MEMORY_POWER_COMMAND_GET_AVERAGE_POWER_CONSUMED 0x03
889	#define EFI_ACPI_6_0_MPST_MEMORY_POWER_COMMAND_GET_MEMORY_ENERGY_CONSUMED 0x04	899	#define EFI_ACPI_6_0_MPST_MEMORY_POWER_COMMAND_GET_MEMORY_ENERGY_CONSUMED 0x04
890		900
891	///	901	///
892	/// MPST Memory Power Node Table	902	/// MPST Memory Power Node Table
893	///	903	///
894	typedef struct {	904	typedef struct {
895	UINT8 PowerStateValue;	905	UINT8 PowerStateValue;
896	UINT8 PowerStateInformationIndex;	906	UINT8 PowerStateInformationIndex;
897	} EFI_ACPI_6_0_MPST_MEMORY_POWER_STATE;	907	} EFI_ACPI_6_0_MPST_MEMORY_POWER_STATE;
898		908
899	typedef struct {	909	typedef struct {
900	UINT8 Flag;	910	UINT8 Flag;
901	UINT8 Reserved;	911	UINT8 Reserved;
902	UINT16 MemoryPowerNodeId;	912	UINT16 MemoryPowerNodeId;
903	UINT32 Length;	913	UINT32 Length;
904	UINT64 AddressBase;	914	UINT64 AddressBase;
905	UINT64 AddressLength;	915	UINT64 AddressLength;
906	UINT32 NumberOfPowerStates;	916	UINT32 NumberOfPowerStates;
907	UINT32 NumberOfPhysicalComponents;	917	UINT32 NumberOfPhysicalComponents;
908	//EFI_ACPI_6_0_MPST_MEMORY_POWER_STATE MemoryPowerState[NumberOfPowerStates];	918	// EFI_ACPI_6_0_MPST_MEMORY_POWER_STATE MemoryPowerState[NumberOfPowerStates];
909	//UINT16 PhysicalComponentIdentifier[NumberOfPhysicalComponents];	919	// UINT16 PhysicalComponentIdentifier[NumberOfPhysicalComponents];
910	} EFI_ACPI_6_0_MPST_MEMORY_POWER_STRUCTURE;	920	} EFI_ACPI_6_0_MPST_MEMORY_POWER_STRUCTURE;
911		921
912	#define EFI_ACPI_6_0_MPST_MEMORY_POWER_STRUCTURE_FLAG_ENABLE 0x01	922	#define EFI_ACPI_6_0_MPST_MEMORY_POWER_STRUCTURE_FLAG_ENABLE 0x01
913	#define EFI_ACPI_6_0_MPST_MEMORY_POWER_STRUCTURE_FLAG_POWER_MANAGED 0x02	923	#define EFI_ACPI_6_0_MPST_MEMORY_POWER_STRUCTURE_FLAG_POWER_MANAGED 0x02
914	#define EFI_ACPI_6_0_MPST_MEMORY_POWER_STRUCTURE_FLAG_HOT_PLUGGABLE 0x04	924	#define EFI_ACPI_6_0_MPST_MEMORY_POWER_STRUCTURE_FLAG_HOT_PLUGGABLE 0x04
915		925
916	typedef struct {	926	typedef struct {
917	UINT16 MemoryPowerNodeCount;	927	UINT16 MemoryPowerNodeCount;
918	UINT8 Reserved[2];	928	UINT8 Reserved[2];
919	} EFI_ACPI_6_0_MPST_MEMORY_POWER_NODE_TABLE;	929	} EFI_ACPI_6_0_MPST_MEMORY_POWER_NODE_TABLE;
920		930
921	///	931	///
922	/// MPST Memory Power State Characteristics Table	932	/// MPST Memory Power State Characteristics Table
923	///	933	///
924	typedef struct {	934	typedef struct {
925	UINT8 PowerStateStructureID;	935	UINT8 PowerStateStructureID;
926	UINT8 Flag;	936	UINT8 Flag;
927	UINT16 Reserved;	937	UINT16 Reserved;
928	UINT32 AveragePowerConsumedInMPS0;	938	UINT32 AveragePowerConsumedInMPS0;
929	UINT32 RelativePowerSavingToMPS0;	939	UINT32 RelativePowerSavingToMPS0;
930	UINT64 ExitLatencyToMPS0;	940	UINT64 ExitLatencyToMPS0;
931	} EFI_ACPI_6_0_MPST_MEMORY_POWER_STATE_CHARACTERISTICS_STRUCTURE;	941	} EFI_ACPI_6_0_MPST_MEMORY_POWER_STATE_CHARACTERISTICS_STRUCTURE;
932		942
933	#define EFI_ACPI_6_0_MPST_MEMORY_POWER_STATE_CHARACTERISTICS_STRUCTURE_FLAG_MEMORY_CONTENT_PRESERVED 0x01	943	#define EFI_ACPI_6_0_MPST_MEMORY_POWER_STATE_CHARACTERISTICS_STRUCTURE_FLAG_MEMORY_CONTENT_PRESERVED 0x01
934	#define EFI_ACPI_6_0_MPST_MEMORY_POWER_STATE_CHARACTERISTICS_STRUCTURE_FLAG_AUTONOMOUS_MEMORY_POWER_STATE_ENTRY 0x02	944	#define EFI_ACPI_6_0_MPST_MEMORY_POWER_STATE_CHARACTERISTICS_STRUCTURE_FLAG_AUTONOMOUS_MEMORY_POWER_STATE_ENTRY 0x02
935	#define EFI_ACPI_6_0_MPST_MEMORY_POWER_STATE_CHARACTERISTICS_STRUCTURE_FLAG_AUTONOMOUS_MEMORY_POWER_STATE_EXIT 0x04	945	#define EFI_ACPI_6_0_MPST_MEMORY_POWER_STATE_CHARACTERISTICS_STRUCTURE_FLAG_AUTONOMOUS_MEMORY_POWER_STATE_EXIT 0x04
936		946
937	typedef struct {	947	typedef struct {
938	UINT16 MemoryPowerStateCharacteristicsCount;	948	UINT16 MemoryPowerStateCharacteristicsCount;
939	UINT8 Reserved[2];	949	UINT8 Reserved[2];
940	} EFI_ACPI_6_0_MPST_MEMORY_POWER_STATE_CHARACTERISTICS_TABLE;	950	} EFI_ACPI_6_0_MPST_MEMORY_POWER_STATE_CHARACTERISTICS_TABLE;
941		951
942	///	952	///
943	/// Memory Topology Table definition.	953	/// Memory Topology Table definition.
944	///	954	///
945	typedef struct {	955	typedef struct {
946	EFI_ACPI_DESCRIPTION_HEADER Header;	956	EFI_ACPI_DESCRIPTION_HEADER Header;
947	UINT32 Reserved;	957	UINT32 Reserved;
948	} EFI_ACPI_6_0_MEMORY_TOPOLOGY_TABLE;	958	} EFI_ACPI_6_0_MEMORY_TOPOLOGY_TABLE;
949		959
950	///	960	///
951	/// PMTT Version (as defined in ACPI 6.0 spec.)	961	/// PMTT Version (as defined in ACPI 6.0 spec.)
952	///	962	///
953	#define EFI_ACPI_6_0_MEMORY_TOPOLOGY_TABLE_REVISION 0x01	963	#define EFI_ACPI_6_0_MEMORY_TOPOLOGY_TABLE_REVISION 0x01
954		964
955	///	965	///
956	/// Common Memory Aggregator Device Structure.	966	/// Common Memory Aggregator Device Structure.
957	///	967	///
958	typedef struct {	968	typedef struct {
959	UINT8 Type;	969	UINT8 Type;
960	UINT8 Reserved;	970	UINT8 Reserved;
961	UINT16 Length;	971	UINT16 Length;
962	UINT16 Flags;	972	UINT16 Flags;
963	UINT16 Reserved1;	973	UINT16 Reserved1;
964	} EFI_ACPI_6_0_PMMT_COMMON_MEMORY_AGGREGATOR_DEVICE_STRUCTURE;	974	} EFI_ACPI_6_0_PMMT_COMMON_MEMORY_AGGREGATOR_DEVICE_STRUCTURE;
965		975
966	///	976	///
967	/// Memory Aggregator Device Type	977	/// Memory Aggregator Device Type
968	///	978	///
969	#define EFI_ACPI_6_0_PMMT_MEMORY_AGGREGATOR_DEVICE_TYPE_SOCKET 0x1	979	#define EFI_ACPI_6_0_PMMT_MEMORY_AGGREGATOR_DEVICE_TYPE_SOCKET 0x0
970	#define EFI_ACPI_6_0_PMMT_MEMORY_AGGREGATOR_DEVICE_TYPE_MEMORY_CONTROLLER 0x2	980	#define EFI_ACPI_6_0_PMMT_MEMORY_AGGREGATOR_DEVICE_TYPE_MEMORY_CONTROLLER 0x1
971	#define EFI_ACPI_6_0_PMMT_MEMORY_AGGREGATOR_DEVICE_TYPE_DIMM 0x3	981	#define EFI_ACPI_6_0_PMMT_MEMORY_AGGREGATOR_DEVICE_TYPE_DIMM 0x2
972		982
973	///	983	///
974	/// Socket Memory Aggregator Device Structure.	984	/// Socket Memory Aggregator Device Structure.
975	///	985	///
976	typedef struct {	986	typedef struct {
977	EFI_ACPI_6_0_PMMT_COMMON_MEMORY_AGGREGATOR_DEVICE_STRUCTURE Header;	987	EFI_ACPI_6_0_PMMT_COMMON_MEMORY_AGGREGATOR_DEVICE_STRUCTURE Header;
978	UINT16 SocketIdentifier;	988	UINT16 SocketIdentifier;
979	UINT16 Reserved;	989	UINT16 Reserved;
980	//EFI_ACPI_6_0_PMMT_MEMORY_CONTROLLER_MEMORY_AGGREGATOR_DEVICE_STRUCTURE MemoryController[];	990	// EFI_ACPI_6_0_PMMT_MEMORY_CONTROLLER_MEMORY_AGGREGATOR_DEVICE_STRUCTURE MemoryController[];
981	} EFI_ACPI_6_0_PMMT_SOCKET_MEMORY_AGGREGATOR_DEVICE_STRUCTURE;	991	} EFI_ACPI_6_0_PMMT_SOCKET_MEMORY_AGGREGATOR_DEVICE_STRUCTURE;
982		992
983	///	993	///
984	/// MemoryController Memory Aggregator Device Structure.	994	/// MemoryController Memory Aggregator Device Structure.
985	///	995	///
986	typedef struct {	996	typedef struct {
987	EFI_ACPI_6_0_PMMT_COMMON_MEMORY_AGGREGATOR_DEVICE_STRUCTURE Header;	997	EFI_ACPI_6_0_PMMT_COMMON_MEMORY_AGGREGATOR_DEVICE_STRUCTURE Header;
988	UINT32 ReadLatency;	998	UINT32 ReadLatency;
989	UINT32 WriteLatency;	999	UINT32 WriteLatency;
990	UINT32 ReadBandwidth;	1000	UINT32 ReadBandwidth;
991	UINT32 WriteBandwidth;	1001	UINT32 WriteBandwidth;
992	UINT16 OptimalAccessUnit;	1002	UINT16 OptimalAccessUnit;
993	UINT16 OptimalAccessAlignment;	1003	UINT16 OptimalAccessAlignment;
994	UINT16 Reserved;	1004	UINT16 Reserved;
995	UINT16 NumberOfProximityDomains;	1005	UINT16 NumberOfProximityDomains;
996	//UINT32 ProximityDomain[NumberOfProximityDomains];	1006	// UINT32 ProximityDomain[NumberOfProximityDomains];
997	//EFI_ACPI_6_0_PMMT_DIMM_MEMORY_AGGREGATOR_DEVICE_STRUCTURE PhysicalComponent[];	1007	// EFI_ACPI_6_0_PMMT_DIMM_MEMORY_AGGREGATOR_DEVICE_STRUCTURE PhysicalComponent[];
998	} EFI_ACPI_6_0_PMMT_MEMORY_CONTROLLER_MEMORY_AGGREGATOR_DEVICE_STRUCTURE;	1008	} EFI_ACPI_6_0_PMMT_MEMORY_CONTROLLER_MEMORY_AGGREGATOR_DEVICE_STRUCTURE;
999		1009
1000	///	1010	///
1001	/// DIMM Memory Aggregator Device Structure.	1011	/// DIMM Memory Aggregator Device Structure.
1002	///	1012	///
1003	typedef struct {	1013	typedef struct {
1004	EFI_ACPI_6_0_PMMT_COMMON_MEMORY_AGGREGATOR_DEVICE_STRUCTURE Header;	1014	EFI_ACPI_6_0_PMMT_COMMON_MEMORY_AGGREGATOR_DEVICE_STRUCTURE Header;
1005	UINT16 PhysicalComponentIdentifier;	1015	UINT16 PhysicalComponentIdentifier;
1006	UINT16 Reserved;	1016	UINT16 Reserved;
1007	UINT32 SizeOfDimm;	1017	UINT32 SizeOfDimm;
1008	UINT32 SmbiosHandle;	1018	UINT32 SmbiosHandle;
1009	} EFI_ACPI_6_0_PMMT_DIMM_MEMORY_AGGREGATOR_DEVICE_STRUCTURE;	1019	} EFI_ACPI_6_0_PMMT_DIMM_MEMORY_AGGREGATOR_DEVICE_STRUCTURE;
1010		1020
1011	///	1021	///
1012	/// Boot Graphics Resource Table definition.	1022	/// Boot Graphics Resource Table definition.
1013	///	1023	///
1014	typedef struct {	1024	typedef struct {
1015	EFI_ACPI_DESCRIPTION_HEADER Header;	1025	EFI_ACPI_DESCRIPTION_HEADER Header;
1016	///	1026	///
1017	/// 2-bytes (16 bit) version ID. This value must be 1.	1027	/// 2-bytes (16 bit) version ID. This value must be 1.
1018	///	1028	///
1019	UINT16 Version;	1029	UINT16 Version;
1020	///	1030	///
1021	/// 1-byte status field indicating current status about the table.	1031	/// 1-byte status field indicating current status about the table.
1022	/// Bits[7:1] = Reserved (must be zero)	1032	/// Bits[7:1] = Reserved (must be zero)
1023	/// Bit [0] = Valid. A one indicates the boot image graphic is valid.	1033	/// Bit [0] = Valid. A one indicates the boot image graphic is valid.
1024	///	1034	///
1025	UINT8 Status;	1035	UINT8 Status;
1026	///	1036	///
1027	/// 1-byte enumerated type field indicating format of the image.	1037	/// 1-byte enumerated type field indicating format of the image.
1028	/// 0 = Bitmap	1038	/// 0 = Bitmap
1029	/// 1 - 255 Reserved (for future use)	1039	/// 1 - 255 Reserved (for future use)
1030	///	1040	///
1031	UINT8 ImageType;	1041	UINT8 ImageType;
1032	///	1042	///
1033	/// 8-byte (64 bit) physical address pointing to the firmware's in-memory copy	1043	/// 8-byte (64 bit) physical address pointing to the firmware's in-memory copy
1034	/// of the image bitmap.	1044	/// of the image bitmap.
1035	///	1045	///
1036	UINT64 ImageAddress;	1046	UINT64 ImageAddress;
1037	///	1047	///
1038	/// A 4-byte (32-bit) unsigned long describing the display X-offset of the boot image.	1048	/// A 4-byte (32-bit) unsigned long describing the display X-offset of the boot image.
1039	/// (X, Y) display offset of the top left corner of the boot image.	1049	/// (X, Y) display offset of the top left corner of the boot image.
1040	/// The top left corner of the display is at offset (0, 0).	1050	/// The top left corner of the display is at offset (0, 0).
1041	///	1051	///
1042	UINT32 ImageOffsetX;	1052	UINT32 ImageOffsetX;
1043	///	1053	///
1044	/// A 4-byte (32-bit) unsigned long describing the display Y-offset of the boot image.	1054	/// A 4-byte (32-bit) unsigned long describing the display Y-offset of the boot image.
1045	/// (X, Y) display offset of the top left corner of the boot image.	1055	/// (X, Y) display offset of the top left corner of the boot image.
1046	/// The top left corner of the display is at offset (0, 0).	1056	/// The top left corner of the display is at offset (0, 0).
1047	///	1057	///
1048	UINT32 ImageOffsetY;	1058	UINT32 ImageOffsetY;
1049	} EFI_ACPI_6_0_BOOT_GRAPHICS_RESOURCE_TABLE;	1059	} EFI_ACPI_6_0_BOOT_GRAPHICS_RESOURCE_TABLE;
1050		1060
1051	///	1061	///
1052	/// BGRT Revision	1062	/// BGRT Revision
1053	///	1063	///
1054	#define EFI_ACPI_6_0_BOOT_GRAPHICS_RESOURCE_TABLE_REVISION 1	1064	#define EFI_ACPI_6_0_BOOT_GRAPHICS_RESOURCE_TABLE_REVISION 1
1055		1065
1056	///	1066	///
1057	/// BGRT Version	1067	/// BGRT Version
1058	///	1068	///
1059	#define EFI_ACPI_6_0_BGRT_VERSION 0x01	1069	#define EFI_ACPI_6_0_BGRT_VERSION 0x01
1060		1070
1061	///	1071	///
1062	/// BGRT Status	1072	/// BGRT Status
1063	///	1073	///
1064	#define EFI_ACPI_6_0_BGRT_STATUS_NOT_DISPLAYED 0x00	1074	#define EFI_ACPI_6_0_BGRT_STATUS_NOT_DISPLAYED 0x00
1065	#define EFI_ACPI_6_0_BGRT_STATUS_DISPLAYED 0x01	1075	#define EFI_ACPI_6_0_BGRT_STATUS_DISPLAYED 0x01
1066		1076
1067	///	1077	///
1068	/// BGRT Image Type	1078	/// BGRT Image Type
Lines 1072-1097 typedef struct { Link Here
1072	///	1082	///
1073	/// FPDT Version (as defined in ACPI 6.0 spec.)	1083	/// FPDT Version (as defined in ACPI 6.0 spec.)
1074	///	1084	///
1075	#define EFI_ACPI_6_0_FIRMWARE_PERFORMANCE_DATA_TABLE_REVISION 0x01	1085	#define EFI_ACPI_6_0_FIRMWARE_PERFORMANCE_DATA_TABLE_REVISION 0x01
1076		1086
1077	///	1087	///
1078	/// FPDT Performance Record Types	1088	/// FPDT Performance Record Types
1079	///	1089	///
1080	#define EFI_ACPI_6_0_FPDT_RECORD_TYPE_FIRMWARE_BASIC_BOOT_POINTER 0x0000	1090	#define EFI_ACPI_6_0_FPDT_RECORD_TYPE_FIRMWARE_BASIC_BOOT_POINTER 0x0000
1081	#define EFI_ACPI_6_0_FPDT_RECORD_TYPE_S3_PERFORMANCE_TABLE_POINTER 0x0001	1091	#define EFI_ACPI_6_0_FPDT_RECORD_TYPE_S3_PERFORMANCE_TABLE_POINTER 0x0001
1082		1092
1083	///	1093	///
1084	/// FPDT Performance Record Revision	1094	/// FPDT Performance Record Revision
1085	///	1095	///
1086	#define EFI_ACPI_6_0_FPDT_RECORD_REVISION_FIRMWARE_BASIC_BOOT_POINTER 0x01	1096	#define EFI_ACPI_6_0_FPDT_RECORD_REVISION_FIRMWARE_BASIC_BOOT_POINTER 0x01
1087	#define EFI_ACPI_6_0_FPDT_RECORD_REVISION_S3_PERFORMANCE_TABLE_POINTER 0x01	1097	#define EFI_ACPI_6_0_FPDT_RECORD_REVISION_S3_PERFORMANCE_TABLE_POINTER 0x01
1088		1098
1089	///	1099	///
1090	/// FPDT Runtime Performance Record Types	1100	/// FPDT Runtime Performance Record Types
1091	///	1101	///
1092	#define EFI_ACPI_6_0_FPDT_RUNTIME_RECORD_TYPE_S3_RESUME 0x0000	1102	#define EFI_ACPI_6_0_FPDT_RUNTIME_RECORD_TYPE_S3_RESUME 0x0000
1093	#define EFI_ACPI_6_0_FPDT_RUNTIME_RECORD_TYPE_S3_SUSPEND 0x0001	1103	#define EFI_ACPI_6_0_FPDT_RUNTIME_RECORD_TYPE_S3_SUSPEND 0x0001
1094	#define EFI_ACPI_6_0_FPDT_RUNTIME_RECORD_TYPE_FIRMWARE_BASIC_BOOT 0x0002	1104	#define EFI_ACPI_6_0_FPDT_RUNTIME_RECORD_TYPE_FIRMWARE_BASIC_BOOT 0x0002
1095		1105
1096	///	1106	///
1097	/// FPDT Runtime Performance Record Revision	1107	/// FPDT Runtime Performance Record Revision
Lines 1104-1180 typedef struct { Link Here
1104	/// FPDT Performance Record header	1114	/// FPDT Performance Record header
1105	///	1115	///
1106	typedef struct {	1116	typedef struct {
1107	UINT16 Type;	1117	UINT16 Type;
1108	UINT8 Length;	1118	UINT8 Length;
1109	UINT8 Revision;	1119	UINT8 Revision;
1110	} EFI_ACPI_6_0_FPDT_PERFORMANCE_RECORD_HEADER;	1120	} EFI_ACPI_6_0_FPDT_PERFORMANCE_RECORD_HEADER;
1111		1121
1112	///	1122	///
1113	/// FPDT Performance Table header	1123	/// FPDT Performance Table header
1114	///	1124	///
1115	typedef struct {	1125	typedef struct {
1116	UINT32 Signature;	1126	UINT32 Signature;
1117	UINT32 Length;	1127	UINT32 Length;
1118	} EFI_ACPI_6_0_FPDT_PERFORMANCE_TABLE_HEADER;	1128	} EFI_ACPI_6_0_FPDT_PERFORMANCE_TABLE_HEADER;
1119		1129
1120	///	1130	///
1121	/// FPDT Firmware Basic Boot Performance Pointer Record Structure	1131	/// FPDT Firmware Basic Boot Performance Pointer Record Structure
1122	///	1132	///
1123	typedef struct {	1133	typedef struct {
1124	EFI_ACPI_6_0_FPDT_PERFORMANCE_RECORD_HEADER Header;	1134	EFI_ACPI_6_0_FPDT_PERFORMANCE_RECORD_HEADER Header;
1125	UINT32 Reserved;	1135	UINT32 Reserved;
1126	///	1136	///
1127	/// 64-bit processor-relative physical address of the Basic Boot Performance Table.	1137	/// 64-bit processor-relative physical address of the Basic Boot Performance Table.
1128	///	1138	///
1129	UINT64 BootPerformanceTablePointer;	1139	UINT64 BootPerformanceTablePointer;
1130	} EFI_ACPI_6_0_FPDT_BOOT_PERFORMANCE_TABLE_POINTER_RECORD;	1140	} EFI_ACPI_6_0_FPDT_BOOT_PERFORMANCE_TABLE_POINTER_RECORD;
1131		1141
1132	///	1142	///
1133	/// FPDT S3 Performance Table Pointer Record Structure	1143	/// FPDT S3 Performance Table Pointer Record Structure
1134	///	1144	///
1135	typedef struct {	1145	typedef struct {
1136	EFI_ACPI_6_0_FPDT_PERFORMANCE_RECORD_HEADER Header;	1146	EFI_ACPI_6_0_FPDT_PERFORMANCE_RECORD_HEADER Header;
1137	UINT32 Reserved;	1147	UINT32 Reserved;
1138	///	1148	///
1139	/// 64-bit processor-relative physical address of the S3 Performance Table.	1149	/// 64-bit processor-relative physical address of the S3 Performance Table.
1140	///	1150	///
1141	UINT64 S3PerformanceTablePointer;	1151	UINT64 S3PerformanceTablePointer;
1142	} EFI_ACPI_6_0_FPDT_S3_PERFORMANCE_TABLE_POINTER_RECORD;	1152	} EFI_ACPI_6_0_FPDT_S3_PERFORMANCE_TABLE_POINTER_RECORD;
1143		1153
1144	///	1154	///
1145	/// FPDT Firmware Basic Boot Performance Record Structure	1155	/// FPDT Firmware Basic Boot Performance Record Structure
1146	///	1156	///
1147	typedef struct {	1157	typedef struct {
1148	EFI_ACPI_6_0_FPDT_PERFORMANCE_RECORD_HEADER Header;	1158	EFI_ACPI_6_0_FPDT_PERFORMANCE_RECORD_HEADER Header;
1149	UINT32 Reserved;	1159	UINT32 Reserved;
1150	///	1160	///
1151	/// Timer value logged at the beginning of firmware image execution.	1161	/// Timer value logged at the beginning of firmware image execution.
1152	/// This may not always be zero or near zero.	1162	/// This may not always be zero or near zero.
1153	///	1163	///
1154	UINT64 ResetEnd;	1164	UINT64 ResetEnd;
1155	///	1165	///
1156	/// Timer value logged just prior to loading the OS boot loader into memory.	1166	/// Timer value logged just prior to loading the OS boot loader into memory.
1157	/// For non-UEFI compatible boots, this field must be zero.	1167	/// For non-UEFI compatible boots, this field must be zero.
1158	///	1168	///
1159	UINT64 OsLoaderLoadImageStart;	1169	UINT64 OsLoaderLoadImageStart;
1160	///	1170	///
1161	/// Timer value logged just prior to launching the previously loaded OS boot loader image.	1171	/// Timer value logged just prior to launching the previously loaded OS boot loader image.
1162	/// For non-UEFI compatible boots, the timer value logged will be just prior	1172	/// For non-UEFI compatible boots, the timer value logged will be just prior
1163	/// to the INT 19h handler invocation.	1173	/// to the INT 19h handler invocation.
1164	///	1174	///
1165	UINT64 OsLoaderStartImageStart;	1175	UINT64 OsLoaderStartImageStart;
1166	///	1176	///
1167	/// Timer value logged at the point when the OS loader calls the	1177	/// Timer value logged at the point when the OS loader calls the
1168	/// ExitBootServices function for UEFI compatible firmware.	1178	/// ExitBootServices function for UEFI compatible firmware.
1169	/// For non-UEFI compatible boots, this field must be zero.	1179	/// For non-UEFI compatible boots, this field must be zero.
1170	///	1180	///
1171	UINT64 ExitBootServicesEntry;	1181	UINT64 ExitBootServicesEntry;
1172	///	1182	///
1173	/// Timer value logged at the point just prior to when the OS loader gaining	1183	/// Timer value logged at the point just prior to when the OS loader gaining
1174	/// control back from calls the ExitBootServices function for UEFI compatible firmware.	1184	/// control back from calls the ExitBootServices function for UEFI compatible firmware.
1175	/// For non-UEFI compatible boots, this field must be zero.	1185	/// For non-UEFI compatible boots, this field must be zero.
1176	///	1186	///
1177	UINT64 ExitBootServicesExit;	1187	UINT64 ExitBootServicesExit;
1178	} EFI_ACPI_6_0_FPDT_FIRMWARE_BASIC_BOOT_RECORD;	1188	} EFI_ACPI_6_0_FPDT_FIRMWARE_BASIC_BOOT_RECORD;
1179		1189
1180	///	1190	///
Lines 1186-1192 typedef struct { Link Here
1186	// FPDT Firmware Basic Boot Performance Table	1196	// FPDT Firmware Basic Boot Performance Table
1187	//	1197	//
1188	typedef struct {	1198	typedef struct {
1189	EFI_ACPI_6_0_FPDT_PERFORMANCE_TABLE_HEADER Header;	1199	EFI_ACPI_6_0_FPDT_PERFORMANCE_TABLE_HEADER Header;
1190	//	1200	//
1191	// one or more Performance Records.	1201	// one or more Performance Records.
1192	//	1202	//
Lines 1201-1207 typedef struct { Link Here
1201	// FPDT Firmware S3 Boot Performance Table	1211	// FPDT Firmware S3 Boot Performance Table
1202	//	1212	//
1203	typedef struct {	1213	typedef struct {
1204	EFI_ACPI_6_0_FPDT_PERFORMANCE_TABLE_HEADER Header;	1214	EFI_ACPI_6_0_FPDT_PERFORMANCE_TABLE_HEADER Header;
1205	//	1215	//
1206	// one or more Performance Records.	1216	// one or more Performance Records.
1207	//	1217	//
Lines 1211-1355 typedef struct { Link Here
1211	/// FPDT Basic S3 Resume Performance Record	1221	/// FPDT Basic S3 Resume Performance Record
1212	///	1222	///
1213	typedef struct {	1223	typedef struct {
1214	EFI_ACPI_6_0_FPDT_PERFORMANCE_RECORD_HEADER Header;	1224	EFI_ACPI_6_0_FPDT_PERFORMANCE_RECORD_HEADER Header;
1215	///	1225	///
1216	/// A count of the number of S3 resume cycles since the last full boot sequence.	1226	/// A count of the number of S3 resume cycles since the last full boot sequence.
1217	///	1227	///
1218	UINT32 ResumeCount;	1228	UINT32 ResumeCount;
1219	///	1229	///
1220	/// Timer recorded at the end of BIOS S3 resume, just prior to handoff to the	1230	/// Timer recorded at the end of BIOS S3 resume, just prior to handoff to the
1221	/// OS waking vector. Only the most recent resume cycle's time is retained.	1231	/// OS waking vector. Only the most recent resume cycle's time is retained.
1222	///	1232	///
1223	UINT64 FullResume;	1233	UINT64 FullResume;
1224	///	1234	///
1225	/// Average timer value of all resume cycles logged since the last full boot	1235	/// Average timer value of all resume cycles logged since the last full boot
1226	/// sequence, including the most recent resume. Note that the entire log of	1236	/// sequence, including the most recent resume. Note that the entire log of
1227	/// timer values does not need to be retained in order to calculate this average.	1237	/// timer values does not need to be retained in order to calculate this average.
1228	///	1238	///
1229	UINT64 AverageResume;	1239	UINT64 AverageResume;
1230	} EFI_ACPI_6_0_FPDT_S3_RESUME_RECORD;	1240	} EFI_ACPI_6_0_FPDT_S3_RESUME_RECORD;
1231		1241
1232	///	1242	///
1233	/// FPDT Basic S3 Suspend Performance Record	1243	/// FPDT Basic S3 Suspend Performance Record
1234	///	1244	///
1235	typedef struct {	1245	typedef struct {
1236	EFI_ACPI_6_0_FPDT_PERFORMANCE_RECORD_HEADER Header;	1246	EFI_ACPI_6_0_FPDT_PERFORMANCE_RECORD_HEADER Header;
1237	///	1247	///
1238	/// Timer value recorded at the OS write to SLP_TYP upon entry to S3.	1248	/// Timer value recorded at the OS write to SLP_TYP upon entry to S3.
1239	/// Only the most recent suspend cycle's timer value is retained.	1249	/// Only the most recent suspend cycle's timer value is retained.
1240	///	1250	///
1241	UINT64 SuspendStart;	1251	UINT64 SuspendStart;
1242	///	1252	///
1243	/// Timer value recorded at the final firmware write to SLP_TYP (or other	1253	/// Timer value recorded at the final firmware write to SLP_TYP (or other
1244	/// mechanism) used to trigger hardware entry to S3.	1254	/// mechanism) used to trigger hardware entry to S3.
1245	/// Only the most recent suspend cycle's timer value is retained.	1255	/// Only the most recent suspend cycle's timer value is retained.
1246	///	1256	///
1247	UINT64 SuspendEnd;	1257	UINT64 SuspendEnd;
1248	} EFI_ACPI_6_0_FPDT_S3_SUSPEND_RECORD;	1258	} EFI_ACPI_6_0_FPDT_S3_SUSPEND_RECORD;
1249		1259
1250	///	1260	///
1251	/// Firmware Performance Record Table definition.	1261	/// Firmware Performance Record Table definition.
1252	///	1262	///
1253	typedef struct {	1263	typedef struct {
1254	EFI_ACPI_DESCRIPTION_HEADER Header;	1264	EFI_ACPI_DESCRIPTION_HEADER Header;
1255	} EFI_ACPI_6_0_FIRMWARE_PERFORMANCE_RECORD_TABLE;	1265	} EFI_ACPI_6_0_FIRMWARE_PERFORMANCE_RECORD_TABLE;
1256		1266
1257	///	1267	///
1258	/// Generic Timer Description Table definition.	1268	/// Generic Timer Description Table definition.
1259	///	1269	///
1260	typedef struct {	1270	typedef struct {
1261	EFI_ACPI_DESCRIPTION_HEADER Header;	1271	EFI_ACPI_DESCRIPTION_HEADER Header;
1262	UINT64 CntControlBasePhysicalAddress;	1272	UINT64 CntControlBasePhysicalAddress;
1263	UINT32 Reserved;	1273	UINT32 Reserved;
1264	UINT32 SecurePL1TimerGSIV;	1274	UINT32 SecurePL1TimerGSIV;
1265	UINT32 SecurePL1TimerFlags;	1275	UINT32 SecurePL1TimerFlags;
1266	UINT32 NonSecurePL1TimerGSIV;	1276	UINT32 NonSecurePL1TimerGSIV;
1267	UINT32 NonSecurePL1TimerFlags;	1277	UINT32 NonSecurePL1TimerFlags;
1268	UINT32 VirtualTimerGSIV;	1278	UINT32 VirtualTimerGSIV;
1269	UINT32 VirtualTimerFlags;	1279	UINT32 VirtualTimerFlags;
1270	UINT32 NonSecurePL2TimerGSIV;	1280	UINT32 NonSecurePL2TimerGSIV;
1271	UINT32 NonSecurePL2TimerFlags;	1281	UINT32 NonSecurePL2TimerFlags;
1272	UINT64 CntReadBasePhysicalAddress;	1282	UINT64 CntReadBasePhysicalAddress;
1273	UINT32 PlatformTimerCount;	1283	UINT32 PlatformTimerCount;
1274	UINT32 PlatformTimerOffset;	1284	UINT32 PlatformTimerOffset;
1275	} EFI_ACPI_6_0_GENERIC_TIMER_DESCRIPTION_TABLE;	1285	} EFI_ACPI_6_0_GENERIC_TIMER_DESCRIPTION_TABLE;
1276		1286
1277	///	1287	///
1278	/// GTDT Version (as defined in ACPI 6.0 spec.)	1288	/// GTDT Version (as defined in ACPI 6.0 spec.)
1279	///	1289	///
1280	#define EFI_ACPI_6_0_GENERIC_TIMER_DESCRIPTION_TABLE_REVISION 0x02	1290	#define EFI_ACPI_6_0_GENERIC_TIMER_DESCRIPTION_TABLE_REVISION 0x02
1281		1291
1282	///	1292	///
1283	/// Timer Flags. All other bits are reserved and must be 0.	1293	/// Timer Flags. All other bits are reserved and must be 0.
1284	///	1294	///
1285	#define EFI_ACPI_6_0_GTDT_TIMER_FLAG_TIMER_INTERRUPT_MODE BIT0	1295	#define EFI_ACPI_6_0_GTDT_TIMER_FLAG_TIMER_INTERRUPT_MODE BIT0
1286	#define EFI_ACPI_6_0_GTDT_TIMER_FLAG_TIMER_INTERRUPT_POLARITY BIT1	1296	#define EFI_ACPI_6_0_GTDT_TIMER_FLAG_TIMER_INTERRUPT_POLARITY BIT1
1287	#define EFI_ACPI_6_0_GTDT_TIMER_FLAG_ALWAYS_ON_CAPABILITY BIT2	1297	#define EFI_ACPI_6_0_GTDT_TIMER_FLAG_ALWAYS_ON_CAPABILITY BIT2
1288		1298
1289	///	1299	///
1290	/// Platform Timer Type	1300	/// Platform Timer Type
1291	///	1301	///
1292	#define EFI_ACPI_6_0_GTDT_GT_BLOCK 0	1302	#define EFI_ACPI_6_0_GTDT_GT_BLOCK 0
1293	#define EFI_ACPI_6_0_GTDT_SBSA_GENERIC_WATCHDOG 1	1303	#define EFI_ACPI_6_0_GTDT_SBSA_GENERIC_WATCHDOG 1
1294		1304
1295	///	1305	///
1296	/// GT Block Structure	1306	/// GT Block Structure
1297	///	1307	///
1298	typedef struct {	1308	typedef struct {
1299	UINT8 Type;	1309	UINT8 Type;
1300	UINT16 Length;	1310	UINT16 Length;
1301	UINT8 Reserved;	1311	UINT8 Reserved;
1302	UINT64 CntCtlBase;	1312	UINT64 CntCtlBase;
1303	UINT32 GTBlockTimerCount;	1313	UINT32 GTBlockTimerCount;
1304	UINT32 GTBlockTimerOffset;	1314	UINT32 GTBlockTimerOffset;
1305	} EFI_ACPI_6_0_GTDT_GT_BLOCK_STRUCTURE;	1315	} EFI_ACPI_6_0_GTDT_GT_BLOCK_STRUCTURE;
1306		1316
1307	///	1317	///
1308	/// GT Block Timer Structure	1318	/// GT Block Timer Structure
1309	///	1319	///
1310	typedef struct {	1320	typedef struct {
1311	UINT8 GTFrameNumber;	1321	UINT8 GTFrameNumber;
1312	UINT8 Reserved[3];	1322	UINT8 Reserved[3];
1313	UINT64 CntBaseX;	1323	UINT64 CntBaseX;
1314	UINT64 CntEL0BaseX;	1324	UINT64 CntEL0BaseX;
1315	UINT32 GTxPhysicalTimerGSIV;	1325	UINT32 GTxPhysicalTimerGSIV;
1316	UINT32 GTxPhysicalTimerFlags;	1326	UINT32 GTxPhysicalTimerFlags;
1317	UINT32 GTxVirtualTimerGSIV;	1327	UINT32 GTxVirtualTimerGSIV;
1318	UINT32 GTxVirtualTimerFlags;	1328	UINT32 GTxVirtualTimerFlags;
1319	UINT32 GTxCommonFlags;	1329	UINT32 GTxCommonFlags;
1320	} EFI_ACPI_6_0_GTDT_GT_BLOCK_TIMER_STRUCTURE;	1330	} EFI_ACPI_6_0_GTDT_GT_BLOCK_TIMER_STRUCTURE;
1321		1331
1322	///	1332	///
1323	/// GT Block Physical Timers and Virtual Timers Flags. All other bits are reserved and must be 0.	1333	/// GT Block Physical Timers and Virtual Timers Flags. All other bits are reserved and must be 0.
1324	///	1334	///
1325	#define EFI_ACPI_6_0_GTDT_GT_BLOCK_TIMER_FLAG_TIMER_INTERRUPT_MODE BIT0	1335	#define EFI_ACPI_6_0_GTDT_GT_BLOCK_TIMER_FLAG_TIMER_INTERRUPT_MODE BIT0
1326	#define EFI_ACPI_6_0_GTDT_GT_BLOCK_TIMER_FLAG_TIMER_INTERRUPT_POLARITY BIT1	1336	#define EFI_ACPI_6_0_GTDT_GT_BLOCK_TIMER_FLAG_TIMER_INTERRUPT_POLARITY BIT1
1327		1337
1328	///	1338	///
1329	/// Common Flags Flags. All other bits are reserved and must be 0.	1339	/// Common Flags Flags. All other bits are reserved and must be 0.
1330	///	1340	///
1331	#define EFI_ACPI_6_0_GTDT_GT_BLOCK_COMMON_FLAG_SECURE_TIMER BIT0	1341	#define EFI_ACPI_6_0_GTDT_GT_BLOCK_COMMON_FLAG_SECURE_TIMER BIT0
1332	#define EFI_ACPI_6_0_GTDT_GT_BLOCK_COMMON_FLAG_ALWAYS_ON_CAPABILITY BIT1	1342	#define EFI_ACPI_6_0_GTDT_GT_BLOCK_COMMON_FLAG_ALWAYS_ON_CAPABILITY BIT1
1333		1343
1334	///	1344	///
1335	/// SBSA Generic Watchdog Structure	1345	/// SBSA Generic Watchdog Structure
1336	///	1346	///
1337	typedef struct {	1347	typedef struct {
1338	UINT8 Type;	1348	UINT8 Type;
1339	UINT16 Length;	1349	UINT16 Length;
1340	UINT8 Reserved;	1350	UINT8 Reserved;
1341	UINT64 RefreshFramePhysicalAddress;	1351	UINT64 RefreshFramePhysicalAddress;
1342	UINT64 WatchdogControlFramePhysicalAddress;	1352	UINT64 WatchdogControlFramePhysicalAddress;
1343	UINT32 WatchdogTimerGSIV;	1353	UINT32 WatchdogTimerGSIV;
1344	UINT32 WatchdogTimerFlags;	1354	UINT32 WatchdogTimerFlags;
1345	} EFI_ACPI_6_0_GTDT_SBSA_GENERIC_WATCHDOG_STRUCTURE;	1355	} EFI_ACPI_6_0_GTDT_SBSA_GENERIC_WATCHDOG_STRUCTURE;
1346		1356
1347	///	1357	///
1348	/// SBSA Generic Watchdog Timer Flags. All other bits are reserved and must be 0.	1358	/// SBSA Generic Watchdog Timer Flags. All other bits are reserved and must be 0.
1349	///	1359	///
1350	#define EFI_ACPI_6_0_GTDT_SBSA_GENERIC_WATCHDOG_FLAG_TIMER_INTERRUPT_MODE BIT0	1360	#define EFI_ACPI_6_0_GTDT_SBSA_GENERIC_WATCHDOG_FLAG_TIMER_INTERRUPT_MODE BIT0
1351	#define EFI_ACPI_6_0_GTDT_SBSA_GENERIC_WATCHDOG_FLAG_TIMER_INTERRUPT_POLARITY BIT1	1361	#define EFI_ACPI_6_0_GTDT_SBSA_GENERIC_WATCHDOG_FLAG_TIMER_INTERRUPT_POLARITY BIT1
1352	#define EFI_ACPI_6_0_GTDT_SBSA_GENERIC_WATCHDOG_FLAG_SECURE_TIMER BIT2	1362	#define EFI_ACPI_6_0_GTDT_SBSA_GENERIC_WATCHDOG_FLAG_SECURE_TIMER BIT2
1353		1363
1354	//	1364	//
1355	// NVDIMM Firmware Interface Table definition.	1365	// NVDIMM Firmware Interface Table definition.
Lines 1362-1368 typedef struct { Link Here
1362	//	1372	//
1363	// NFIT Version (as defined in ACPI 6.0 spec.)	1373	// NFIT Version (as defined in ACPI 6.0 spec.)
1364	//	1374	//
1365	#define EFI_ACPI_6_0_NVDIMM_FIRMWARE_INTERFACE_TABLE_REVISION 0x1	1375	#define EFI_ACPI_6_0_NVDIMM_FIRMWARE_INTERFACE_TABLE_REVISION 0x1
1366		1376
1367	//	1377	//
1368	// Definition for NFIT Table Structure Types	1378	// Definition for NFIT Table Structure Types
Lines 1379-1424 typedef struct { Link Here
1379	// Definition for NFIT Structure Header	1389	// Definition for NFIT Structure Header
1380	//	1390	//
1381	typedef struct {	1391	typedef struct {
1382	UINT16 Type;	1392	UINT16 Type;
1383	UINT16 Length;	1393	UINT16 Length;
1384	} EFI_ACPI_6_0_NFIT_STRUCTURE_HEADER;	1394	} EFI_ACPI_6_0_NFIT_STRUCTURE_HEADER;
1385		1395
1386	//	1396	//
1387	// Definition for System Physical Address Range Structure	1397	// Definition for System Physical Address Range Structure
1388	//	1398	//
1389	#define EFI_ACPI_6_0_NFIT_SYSTEM_PHYSICAL_ADDRESS_RANGE_FLAGS_CONTROL_REGION_FOR_MANAGEMENT BIT0	1399	#define EFI_ACPI_6_0_NFIT_SYSTEM_PHYSICAL_ADDRESS_RANGE_FLAGS_CONTROL_REGION_FOR_MANAGEMENT BIT0
1390	#define EFI_ACPI_6_0_NFIT_SYSTEM_PHYSICAL_ADDRESS_RANGE_FLAGS_PROXIMITY_DOMAIN_VALID BIT1	1400	#define EFI_ACPI_6_0_NFIT_SYSTEM_PHYSICAL_ADDRESS_RANGE_FLAGS_PROXIMITY_DOMAIN_VALID BIT1
1391	#define EFI_ACPI_6_0_NFIT_GUID_VOLATILE_MEMORY_REGION { 0x7305944F, 0xFDDA, 0x44E3, { 0xB1, 0x6C, 0x3F, 0x22, 0xD2, 0x52, 0xE5, 0xD0 }}	1401	#define EFI_ACPI_6_0_NFIT_GUID_VOLATILE_MEMORY_REGION { 0x7305944F, 0xFDDA, 0x44E3, { 0xB1, 0x6C, 0x3F, 0x22, 0xD2, 0x52, 0xE5, 0xD0 }}
1392	#define EFI_ACPI_6_0_NFIT_GUID_BYTE_ADDRESSABLE_PERSISTENT_MEMORY_REGION { 0x66F0D379, 0xB4F3, 0x4074, { 0xAC, 0x43, 0x0D, 0x33, 0x18, 0xB7, 0x8C, 0xDB }}	1402	#define EFI_ACPI_6_0_NFIT_GUID_BYTE_ADDRESSABLE_PERSISTENT_MEMORY_REGION { 0x66F0D379, 0xB4F3, 0x4074, { 0xAC, 0x43, 0x0D, 0x33, 0x18, 0xB7, 0x8C, 0xDB }}
1393	#define EFI_ACPI_6_0_NFIT_GUID_NVDIMM_CONTROL_REGION { 0x92F701F6, 0x13B4, 0x405D, { 0x91, 0x0B, 0x29, 0x93, 0x67, 0xE8, 0x23, 0x4C }}	1403	#define EFI_ACPI_6_0_NFIT_GUID_NVDIMM_CONTROL_REGION { 0x92F701F6, 0x13B4, 0x405D, { 0x91, 0x0B, 0x29, 0x93, 0x67, 0xE8, 0x23, 0x4C }}
1394	#define EFI_ACPI_6_0_NFIT_GUID_NVDIMM_BLOCK_DATA_WINDOW_REGION { 0x91AF0530, 0x5D86, 0x470E, { 0xA6, 0xB0, 0x0A, 0x2D, 0xB9, 0x40, 0x82, 0x49 }}	1404	#define EFI_ACPI_6_0_NFIT_GUID_NVDIMM_BLOCK_DATA_WINDOW_REGION { 0x91AF0530, 0x5D86, 0x470E, { 0xA6, 0xB0, 0x0A, 0x2D, 0xB9, 0x40, 0x82, 0x49 }}
1395	#define EFI_ACPI_6_0_NFIT_GUID_RAM_DISK_SUPPORTING_VIRTUAL_DISK_REGION_VOLATILE { 0x77AB535A, 0x45FC, 0x624B, { 0x55, 0x60, 0xF7, 0xB2, 0x81, 0xD1, 0xF9, 0x6E }}	1405	#define EFI_ACPI_6_0_NFIT_GUID_RAM_DISK_SUPPORTING_VIRTUAL_DISK_REGION_VOLATILE { 0x77AB535A, 0x45FC, 0x624B, { 0x55, 0x60, 0xF7, 0xB2, 0x81, 0xD1, 0xF9, 0x6E }}
1396	#define EFI_ACPI_6_0_NFIT_GUID_RAM_DISK_SUPPORTING_VIRTUAL_CD_REGION_VOLATILE { 0x3D5ABD30, 0x4175, 0x87CE, { 0x6D, 0x64, 0xD2, 0xAD, 0xE5, 0x23, 0xC4, 0xBB }}	1406	#define EFI_ACPI_6_0_NFIT_GUID_RAM_DISK_SUPPORTING_VIRTUAL_CD_REGION_VOLATILE { 0x3D5ABD30, 0x4175, 0x87CE, { 0x6D, 0x64, 0xD2, 0xAD, 0xE5, 0x23, 0xC4, 0xBB }}
1397	#define EFI_ACPI_6_0_NFIT_GUID_RAM_DISK_SUPPORTING_VIRTUAL_DISK_REGION_PERSISTENT { 0x5CEA02C9, 0x4D07, 0x69D3, { 0x26, 0x9F ,0x44, 0x96, 0xFB, 0xE0, 0x96, 0xF9 }}	1407	#define EFI_ACPI_6_0_NFIT_GUID_RAM_DISK_SUPPORTING_VIRTUAL_DISK_REGION_PERSISTENT { 0x5CEA02C9, 0x4D07, 0x69D3, { 0x26, 0x9F ,0x44, 0x96, 0xFB, 0xE0, 0x96, 0xF9 }}
1398	#define EFI_ACPI_6_0_NFIT_GUID_RAM_DISK_SUPPORTING_VIRTUAL_CD_REGION_PERSISTENT { 0x08018188, 0x42CD, 0xBB48, { 0x10, 0x0F, 0x53, 0x87, 0xD5, 0x3D, 0xED, 0x3D }}	1408	#define EFI_ACPI_6_0_NFIT_GUID_RAM_DISK_SUPPORTING_VIRTUAL_CD_REGION_PERSISTENT { 0x08018188, 0x42CD, 0xBB48, { 0x10, 0x0F, 0x53, 0x87, 0xD5, 0x3D, 0xED, 0x3D }}
1399	typedef struct {	1409	typedef struct {
1400	UINT16 Type;	1410	UINT16 Type;
1401	UINT16 Length;	1411	UINT16 Length;
1402	UINT16 SPARangeStructureIndex;	1412	UINT16 SPARangeStructureIndex;
1403	UINT16 Flags;	1413	UINT16 Flags;
1404	UINT32 Reserved_8;	1414	UINT32 Reserved_8;
1405	UINT32 ProximityDomain;	1415	UINT32 ProximityDomain;
1406	GUID AddressRangeTypeGUID;	1416	GUID AddressRangeTypeGUID;
1407	UINT64 SystemPhysicalAddressRangeBase;	1417	UINT64 SystemPhysicalAddressRangeBase;
1408	UINT64 SystemPhysicalAddressRangeLength;	1418	UINT64 SystemPhysicalAddressRangeLength;
1409	UINT64 AddressRangeMemoryMappingAttribute;	1419	UINT64 AddressRangeMemoryMappingAttribute;
1410	} EFI_ACPI_6_0_NFIT_SYSTEM_PHYSICAL_ADDRESS_RANGE_STRUCTURE;	1420	} EFI_ACPI_6_0_NFIT_SYSTEM_PHYSICAL_ADDRESS_RANGE_STRUCTURE;
1411		1421
1412	//	1422	//
1413	// Definition for Memory Device to System Physical Address Range Mapping Structure	1423	// Definition for Memory Device to System Physical Address Range Mapping Structure
1414	//	1424	//
1415	typedef struct {	1425	typedef struct {
1416	UINT32 DIMMNumber:4;	1426	UINT32 DIMMNumber : 4;
1417	UINT32 MemoryChannelNumber:4;	1427	UINT32 MemoryChannelNumber : 4;
1418	UINT32 MemoryControllerID:4;	1428	UINT32 MemoryControllerID : 4;
1419	UINT32 SocketID:4;	1429	UINT32 SocketID : 4;
1420	UINT32 NodeControllerID:12;	1430	UINT32 NodeControllerID : 12;
1421	UINT32 Reserved_28:4;	1431	UINT32 Reserved_28 : 4;
1422	} EFI_ACPI_6_0_NFIT_DEVICE_HANDLE;	1432	} EFI_ACPI_6_0_NFIT_DEVICE_HANDLE;
1423		1433
1424	#define EFI_ACPI_6_0_NFIT_MEMORY_DEVICE_STATE_FLAGS_PREVIOUS_SAVE_FAIL BIT0	1434	#define EFI_ACPI_6_0_NFIT_MEMORY_DEVICE_STATE_FLAGS_PREVIOUS_SAVE_FAIL BIT0
Lines 1428-1582 typedef struct { Link Here
1428	#define EFI_ACPI_6_0_NFIT_MEMORY_DEVICE_STATE_FLAGS_SMART_HEALTH_EVENTS_PRIOR_OSPM_HAND_OFF BIT4	1438	#define EFI_ACPI_6_0_NFIT_MEMORY_DEVICE_STATE_FLAGS_SMART_HEALTH_EVENTS_PRIOR_OSPM_HAND_OFF BIT4
1429	#define EFI_ACPI_6_0_NFIT_MEMORY_DEVICE_STATE_FLAGS_FIRMWARE_ENABLED_TO_NOTIFY_OSPM_ON_SMART_HEALTH_EVENTS BIT5	1439	#define EFI_ACPI_6_0_NFIT_MEMORY_DEVICE_STATE_FLAGS_FIRMWARE_ENABLED_TO_NOTIFY_OSPM_ON_SMART_HEALTH_EVENTS BIT5
1430	typedef struct {	1440	typedef struct {
1431	UINT16 Type;	1441	UINT16 Type;
1432	UINT16 Length;	1442	UINT16 Length;
1433	EFI_ACPI_6_0_NFIT_DEVICE_HANDLE NFITDeviceHandle;	1443	EFI_ACPI_6_0_NFIT_DEVICE_HANDLE NFITDeviceHandle;
1434	UINT16 MemoryDevicePhysicalID;	1444	UINT16 MemoryDevicePhysicalID;
1435	UINT16 MemoryDeviceRegionID;	1445	UINT16 MemoryDeviceRegionID;
1436	UINT16 SPARangeStructureIndex ;	1446	UINT16 SPARangeStructureIndex;
1437	UINT16 NVDIMMControlRegionStructureIndex;	1447	UINT16 NVDIMMControlRegionStructureIndex;
1438	UINT64 MemoryDeviceRegionSize;	1448	UINT64 MemoryDeviceRegionSize;
1439	UINT64 RegionOffset;	1449	UINT64 RegionOffset;
1440	UINT64 MemoryDevicePhysicalAddressRegionBase;	1450	UINT64 MemoryDevicePhysicalAddressRegionBase;
1441	UINT16 InterleaveStructureIndex;	1451	UINT16 InterleaveStructureIndex;
1442	UINT16 InterleaveWays;	1452	UINT16 InterleaveWays;
1443	UINT16 MemoryDeviceStateFlags;	1453	UINT16 MemoryDeviceStateFlags;
1444	UINT16 Reserved_46;	1454	UINT16 Reserved_46;
1445	} EFI_ACPI_6_0_NFIT_MEMORY_DEVICE_TO_SYSTEM_ADDRESS_RANGE_MAP_STRUCTURE;	1455	} EFI_ACPI_6_0_NFIT_MEMORY_DEVICE_TO_SYSTEM_ADDRESS_RANGE_MAP_STRUCTURE;
1446		1456
1447	//	1457	//
1448	// Definition for Interleave Structure	1458	// Definition for Interleave Structure
1449	//	1459	//
1450	typedef struct {	1460	typedef struct {
1451	UINT16 Type;	1461	UINT16 Type;
1452	UINT16 Length;	1462	UINT16 Length;
1453	UINT16 InterleaveStructureIndex;	1463	UINT16 InterleaveStructureIndex;
1454	UINT16 Reserved_6;	1464	UINT16 Reserved_6;
1455	UINT32 NumberOfLines;	1465	UINT32 NumberOfLines;
1456	UINT32 LineSize;	1466	UINT32 LineSize;
1457	//UINT32 LineOffset[NumberOfLines];	1467	// UINT32 LineOffset[NumberOfLines];
1458	} EFI_ACPI_6_0_NFIT_INTERLEAVE_STRUCTURE;	1468	} EFI_ACPI_6_0_NFIT_INTERLEAVE_STRUCTURE;
1459		1469
1460	//	1470	//
1461	// Definition for SMBIOS Management Information Structure	1471	// Definition for SMBIOS Management Information Structure
1462	//	1472	//
1463	typedef struct {	1473	typedef struct {
1464	UINT16 Type;	1474	UINT16 Type;
1465	UINT16 Length;	1475	UINT16 Length;
1466	UINT32 Reserved_4;	1476	UINT32 Reserved_4;
1467	//UINT8 Data[];	1477	// UINT8 Data[];
1468	} EFI_ACPI_6_0_NFIT_SMBIOS_MANAGEMENT_INFORMATION_STRUCTURE;	1478	} EFI_ACPI_6_0_NFIT_SMBIOS_MANAGEMENT_INFORMATION_STRUCTURE;
1469		1479
1470	//	1480	//
1471	// Definition for NVDIMM Control Region Structure	1481	// Definition for NVDIMM Control Region Structure
1472	//	1482	//
1473	#define EFI_ACPI_6_0_NFIT_NVDIMM_CONTROL_REGION_FLAGS_BLOCK_DATA_WINDOWS_BUFFERED BIT0	1483	#define EFI_ACPI_6_0_NFIT_NVDIMM_CONTROL_REGION_FLAGS_BLOCK_DATA_WINDOWS_BUFFERED BIT0
1474	typedef struct {	1484	typedef struct {
1475	UINT16 Type;	1485	UINT16 Type;
1476	UINT16 Length;	1486	UINT16 Length;
1477	UINT16 NVDIMMControlRegionStructureIndex;	1487	UINT16 NVDIMMControlRegionStructureIndex;
1478	UINT16 VendorID;	1488	UINT16 VendorID;
1479	UINT16 DeviceID;	1489	UINT16 DeviceID;
1480	UINT16 RevisionID;	1490	UINT16 RevisionID;
1481	UINT16 SubsystemVendorID;	1491	UINT16 SubsystemVendorID;
1482	UINT16 SubsystemDeviceID;	1492	UINT16 SubsystemDeviceID;
1483	UINT16 SubsystemRevisionID;	1493	UINT16 SubsystemRevisionID;
1484	UINT8 Reserved_18[6];	1494	UINT8 Reserved_18[6];
1485	UINT32 SerialNumber;	1495	UINT32 SerialNumber;
1486	UINT16 RegionFormatInterfaceCode;	1496	UINT16 RegionFormatInterfaceCode;
1487	UINT16 NumberOfBlockControlWindows;	1497	UINT16 NumberOfBlockControlWindows;
1488	UINT64 SizeOfBlockControlWindow;	1498	UINT64 SizeOfBlockControlWindow;
1489	UINT64 CommandRegisterOffsetInBlockControlWindow;	1499	UINT64 CommandRegisterOffsetInBlockControlWindow;
1490	UINT64 SizeOfCommandRegisterInBlockControlWindows;	1500	UINT64 SizeOfCommandRegisterInBlockControlWindows;
1491	UINT64 StatusRegisterOffsetInBlockControlWindow;	1501	UINT64 StatusRegisterOffsetInBlockControlWindow;
1492	UINT64 SizeOfStatusRegisterInBlockControlWindows;	1502	UINT64 SizeOfStatusRegisterInBlockControlWindows;
1493	UINT16 NVDIMMControlRegionFlag;	1503	UINT16 NVDIMMControlRegionFlag;
1494	UINT8 Reserved_74[6];	1504	UINT8 Reserved_74[6];
1495	} EFI_ACPI_6_0_NFIT_NVDIMM_CONTROL_REGION_STRUCTURE;	1505	} EFI_ACPI_6_0_NFIT_NVDIMM_CONTROL_REGION_STRUCTURE;
1496		1506
1497	//	1507	//
1498	// Definition for NVDIMM Block Data Window Region Structure	1508	// Definition for NVDIMM Block Data Window Region Structure
1499	//	1509	//
1500	typedef struct {	1510	typedef struct {
1501	UINT16 Type;	1511	UINT16 Type;
1502	UINT16 Length;	1512	UINT16 Length;
1503	UINT16 NVDIMMControlRegionStructureIndex;	1513	UINT16 NVDIMMControlRegionStructureIndex;
1504	UINT16 NumberOfBlockDataWindows;	1514	UINT16 NumberOfBlockDataWindows;
1505	UINT64 BlockDataWindowStartOffset;	1515	UINT64 BlockDataWindowStartOffset;
1506	UINT64 SizeOfBlockDataWindow;	1516	UINT64 SizeOfBlockDataWindow;
1507	UINT64 BlockAccessibleMemoryCapacity;	1517	UINT64 BlockAccessibleMemoryCapacity;
1508	UINT64 BeginningAddressOfFirstBlockInBlockAccessibleMemory;	1518	UINT64 BeginningAddressOfFirstBlockInBlockAccessibleMemory;
1509	} EFI_ACPI_6_0_NFIT_NVDIMM_BLOCK_DATA_WINDOW_REGION_STRUCTURE;	1519	} EFI_ACPI_6_0_NFIT_NVDIMM_BLOCK_DATA_WINDOW_REGION_STRUCTURE;
1510		1520
1511	//	1521	//
1512	// Definition for Flush Hint Address Structure	1522	// Definition for Flush Hint Address Structure
1513	//	1523	//
1514	typedef struct {	1524	typedef struct {
1515	UINT16 Type;	1525	UINT16 Type;
1516	UINT16 Length;	1526	UINT16 Length;
1517	EFI_ACPI_6_0_NFIT_DEVICE_HANDLE NFITDeviceHandle;	1527	EFI_ACPI_6_0_NFIT_DEVICE_HANDLE NFITDeviceHandle;
1518	UINT16 NumberOfFlushHintAddresses;	1528	UINT16 NumberOfFlushHintAddresses;
1519	UINT8 Reserved_10[6];	1529	UINT8 Reserved_10[6];
1520	//UINT64 FlushHintAddress[NumberOfFlushHintAddresses];	1530	// UINT64 FlushHintAddress[NumberOfFlushHintAddresses];
1521	} EFI_ACPI_6_0_NFIT_FLUSH_HINT_ADDRESS_STRUCTURE;	1531	} EFI_ACPI_6_0_NFIT_FLUSH_HINT_ADDRESS_STRUCTURE;
1522		1532
1523	///	1533	///
1524	/// Boot Error Record Table (BERT)	1534	/// Boot Error Record Table (BERT)
1525	///	1535	///
1526	typedef struct {	1536	typedef struct {
1527	EFI_ACPI_DESCRIPTION_HEADER Header;	1537	EFI_ACPI_DESCRIPTION_HEADER Header;
1528	UINT32 BootErrorRegionLength;	1538	UINT32 BootErrorRegionLength;
1529	UINT64 BootErrorRegion;	1539	UINT64 BootErrorRegion;
1530	} EFI_ACPI_6_0_BOOT_ERROR_RECORD_TABLE_HEADER;	1540	} EFI_ACPI_6_0_BOOT_ERROR_RECORD_TABLE_HEADER;
1531		1541
1532	///	1542	///
1533	/// BERT Version (as defined in ACPI 6.0 spec.)	1543	/// BERT Version (as defined in ACPI 6.0 spec.)
1534	///	1544	///
1535	#define EFI_ACPI_6_0_BOOT_ERROR_RECORD_TABLE_REVISION 0x01	1545	#define EFI_ACPI_6_0_BOOT_ERROR_RECORD_TABLE_REVISION 0x01
1536		1546
1537	///	1547	///
1538	/// Boot Error Region Block Status Definition	1548	/// Boot Error Region Block Status Definition
1539	///	1549	///
1540	typedef struct {	1550	typedef struct {
1541	UINT32 UncorrectableErrorValid:1;	1551	UINT32 UncorrectableErrorValid : 1;
1542	UINT32 CorrectableErrorValid:1;	1552	UINT32 CorrectableErrorValid : 1;
1543	UINT32 MultipleUncorrectableErrors:1;	1553	UINT32 MultipleUncorrectableErrors : 1;
1544	UINT32 MultipleCorrectableErrors:1;	1554	UINT32 MultipleCorrectableErrors : 1;
1545	UINT32 ErrorDataEntryCount:10;	1555	UINT32 ErrorDataEntryCount : 10;
1546	UINT32 Reserved:18;	1556	UINT32 Reserved : 18;
1547	} EFI_ACPI_6_0_ERROR_BLOCK_STATUS;	1557	} EFI_ACPI_6_0_ERROR_BLOCK_STATUS;
1548		1558
1549	///	1559	///
1550	/// Boot Error Region Definition	1560	/// Boot Error Region Definition
1551	///	1561	///
1552	typedef struct {	1562	typedef struct {
1553	EFI_ACPI_6_0_ERROR_BLOCK_STATUS BlockStatus;	1563	EFI_ACPI_6_0_ERROR_BLOCK_STATUS BlockStatus;
1554	UINT32 RawDataOffset;	1564	UINT32 RawDataOffset;
1555	UINT32 RawDataLength;	1565	UINT32 RawDataLength;
1556	UINT32 DataLength;	1566	UINT32 DataLength;
1557	UINT32 ErrorSeverity;	1567	UINT32 ErrorSeverity;
1558	} EFI_ACPI_6_0_BOOT_ERROR_REGION_STRUCTURE;	1568	} EFI_ACPI_6_0_BOOT_ERROR_REGION_STRUCTURE;
1559		1569
1560	//	1570	//
1561	// Boot Error Severity types	1571	// Boot Error Severity types
1562	//	1572	//
1563	#define EFI_ACPI_6_0_ERROR_SEVERITY_CORRECTABLE 0x00	1573	#define EFI_ACPI_6_0_ERROR_SEVERITY_RECOVERABLE 0x00
1564	#define EFI_ACPI_6_0_ERROR_SEVERITY_FATAL 0x01	1574	#define EFI_ACPI_6_0_ERROR_SEVERITY_FATAL 0x01
1565	#define EFI_ACPI_6_0_ERROR_SEVERITY_CORRECTED 0x02	1575	#define EFI_ACPI_6_0_ERROR_SEVERITY_CORRECTED 0x02
1566	#define EFI_ACPI_6_0_ERROR_SEVERITY_NONE 0x03	1576	#define EFI_ACPI_6_0_ERROR_SEVERITY_NONE 0x03
		1577	//
		1578	// The term 'Correctable' is no longer being used as an error severity of the
		1579	// reported error since ACPI Specification Version 5.1 Errata B.
		1580	// The below macro is considered as deprecated and should no longer be used.
		1581	//
		1582	#define EFI_ACPI_6_0_ERROR_SEVERITY_CORRECTABLE 0x00
1567		1583
1568	///	1584	///
1569	/// Generic Error Data Entry Definition	1585	/// Generic Error Data Entry Definition
1570	///	1586	///
1571	typedef struct {	1587	typedef struct {
1572	UINT8 SectionType[16];	1588	UINT8 SectionType[16];
1573	UINT32 ErrorSeverity;	1589	UINT32 ErrorSeverity;
1574	UINT16 Revision;	1590	UINT16 Revision;
1575	UINT8 ValidationBits;	1591	UINT8 ValidationBits;
1576	UINT8 Flags;	1592	UINT8 Flags;
1577	UINT32 ErrorDataLength;	1593	UINT32 ErrorDataLength;
1578	UINT8 FruId[16];	1594	UINT8 FruId[16];
1579	UINT8 FruText[20];	1595	UINT8 FruText[20];
1580	} EFI_ACPI_6_0_GENERIC_ERROR_DATA_ENTRY_STRUCTURE;	1596	} EFI_ACPI_6_0_GENERIC_ERROR_DATA_ENTRY_STRUCTURE;
1581		1597
1582	///	1598	///
Lines 1588-1601 typedef struct { Link Here
1588	/// HEST - Hardware Error Source Table	1604	/// HEST - Hardware Error Source Table
1589	///	1605	///
1590	typedef struct {	1606	typedef struct {
1591	EFI_ACPI_DESCRIPTION_HEADER Header;	1607	EFI_ACPI_DESCRIPTION_HEADER Header;
1592	UINT32 ErrorSourceCount;	1608	UINT32 ErrorSourceCount;
1593	} EFI_ACPI_6_0_HARDWARE_ERROR_SOURCE_TABLE_HEADER;	1609	} EFI_ACPI_6_0_HARDWARE_ERROR_SOURCE_TABLE_HEADER;
1594		1610
1595	///	1611	///
1596	/// HEST Version (as defined in ACPI 6.0 spec.)	1612	/// HEST Version (as defined in ACPI 6.0 spec.)
1597	///	1613	///
1598	#define EFI_ACPI_6_0_HARDWARE_ERROR_SOURCE_TABLE_REVISION 0x01	1614	#define EFI_ACPI_6_0_HARDWARE_ERROR_SOURCE_TABLE_REVISION 0x01
1599		1615
1600	//	1616	//
1601	// Error Source structure types.	1617	// Error Source structure types.
Lines 1611-2047 typedef struct { Link Here
1611	//	1627	//
1612	// Error Source structure flags.	1628	// Error Source structure flags.
1613	//	1629	//
1614	#define EFI_ACPI_6_0_ERROR_SOURCE_FLAG_FIRMWARE_FIRST (1 << 0)	1630	#define EFI_ACPI_6_0_ERROR_SOURCE_FLAG_FIRMWARE_FIRST (1 << 0)
1615	#define EFI_ACPI_6_0_ERROR_SOURCE_FLAG_GLOBAL (1 << 1)	1631	#define EFI_ACPI_6_0_ERROR_SOURCE_FLAG_GLOBAL (1 << 1)
1616		1632
1617	///	1633	///
1618	/// IA-32 Architecture Machine Check Exception Structure Definition	1634	/// IA-32 Architecture Machine Check Exception Structure Definition
1619	///	1635	///
1620	typedef struct {	1636	typedef struct {
1621	UINT16 Type;	1637	UINT16 Type;
1622	UINT16 SourceId;	1638	UINT16 SourceId;
1623	UINT8 Reserved0[2];	1639	UINT8 Reserved0[2];
1624	UINT8 Flags;	1640	UINT8 Flags;
1625	UINT8 Enabled;	1641	UINT8 Enabled;
1626	UINT32 NumberOfRecordsToPreAllocate;	1642	UINT32 NumberOfRecordsToPreAllocate;
1627	UINT32 MaxSectionsPerRecord;	1643	UINT32 MaxSectionsPerRecord;
1628	UINT64 GlobalCapabilityInitData;	1644	UINT64 GlobalCapabilityInitData;
1629	UINT64 GlobalControlInitData;	1645	UINT64 GlobalControlInitData;
1630	UINT8 NumberOfHardwareBanks;	1646	UINT8 NumberOfHardwareBanks;
1631	UINT8 Reserved1[7];	1647	UINT8 Reserved1[7];
1632	} EFI_ACPI_6_0_IA32_ARCHITECTURE_MACHINE_CHECK_EXCEPTION_STRUCTURE;	1648	} EFI_ACPI_6_0_IA32_ARCHITECTURE_MACHINE_CHECK_EXCEPTION_STRUCTURE;
1633		1649
1634	///	1650	///
1635	/// IA-32 Architecture Machine Check Bank Structure Definition	1651	/// IA-32 Architecture Machine Check Bank Structure Definition
1636	///	1652	///
1637	typedef struct {	1653	typedef struct {
1638	UINT8 BankNumber;	1654	UINT8 BankNumber;
1639	UINT8 ClearStatusOnInitialization;	1655	UINT8 ClearStatusOnInitialization;
1640	UINT8 StatusDataFormat;	1656	UINT8 StatusDataFormat;
1641	UINT8 Reserved0;	1657	UINT8 Reserved0;
1642	UINT32 ControlRegisterMsrAddress;	1658	UINT32 ControlRegisterMsrAddress;
1643	UINT64 ControlInitData;	1659	UINT64 ControlInitData;
1644	UINT32 StatusRegisterMsrAddress;	1660	UINT32 StatusRegisterMsrAddress;
1645	UINT32 AddressRegisterMsrAddress;	1661	UINT32 AddressRegisterMsrAddress;
1646	UINT32 MiscRegisterMsrAddress;	1662	UINT32 MiscRegisterMsrAddress;
1647	} EFI_ACPI_6_0_IA32_ARCHITECTURE_MACHINE_CHECK_ERROR_BANK_STRUCTURE;	1663	} EFI_ACPI_6_0_IA32_ARCHITECTURE_MACHINE_CHECK_ERROR_BANK_STRUCTURE;
1648		1664
1649	///	1665	///
1650	/// IA-32 Architecture Machine Check Bank Structure MCA data format	1666	/// IA-32 Architecture Machine Check Bank Structure MCA data format
1651	///	1667	///
1652	#define EFI_ACPI_6_0_IA32_ARCHITECTURE_MACHINE_CHECK_ERROR_DATA_FORMAT_IA32 0x00	1668	#define EFI_ACPI_6_0_IA32_ARCHITECTURE_MACHINE_CHECK_ERROR_DATA_FORMAT_IA32 0x00
1653	#define EFI_ACPI_6_0_IA32_ARCHITECTURE_MACHINE_CHECK_ERROR_DATA_FORMAT_INTEL64 0x01	1669	#define EFI_ACPI_6_0_IA32_ARCHITECTURE_MACHINE_CHECK_ERROR_DATA_FORMAT_INTEL64 0x01
1654	#define EFI_ACPI_6_0_IA32_ARCHITECTURE_MACHINE_CHECK_ERROR_DATA_FORMAT_AMD64 0x02	1670	#define EFI_ACPI_6_0_IA32_ARCHITECTURE_MACHINE_CHECK_ERROR_DATA_FORMAT_AMD64 0x02
1655		1671
1656	//	1672	//
1657	// Hardware Error Notification types. All other values are reserved	1673	// Hardware Error Notification types. All other values are reserved
1658	//	1674	//
1659	#define EFI_ACPI_6_0_HARDWARE_ERROR_NOTIFICATION_POLLED 0x00	1675	#define EFI_ACPI_6_0_HARDWARE_ERROR_NOTIFICATION_POLLED 0x00
1660	#define EFI_ACPI_6_0_HARDWARE_ERROR_NOTIFICATION_EXTERNAL_INTERRUPT 0x01	1676	#define EFI_ACPI_6_0_HARDWARE_ERROR_NOTIFICATION_EXTERNAL_INTERRUPT 0x01
1661	#define EFI_ACPI_6_0_HARDWARE_ERROR_NOTIFICATION_LOCAL_INTERRUPT 0x02	1677	#define EFI_ACPI_6_0_HARDWARE_ERROR_NOTIFICATION_LOCAL_INTERRUPT 0x02
1662	#define EFI_ACPI_6_0_HARDWARE_ERROR_NOTIFICATION_SCI 0x03	1678	#define EFI_ACPI_6_0_HARDWARE_ERROR_NOTIFICATION_SCI 0x03
1663	#define EFI_ACPI_6_0_HARDWARE_ERROR_NOTIFICATION_NMI 0x04	1679	#define EFI_ACPI_6_0_HARDWARE_ERROR_NOTIFICATION_NMI 0x04
1664	#define EFI_ACPI_6_0_HARDWARE_ERROR_NOTIFICATION_CMCI 0x05	1680	#define EFI_ACPI_6_0_HARDWARE_ERROR_NOTIFICATION_CMCI 0x05
1665	#define EFI_ACPI_6_0_HARDWARE_ERROR_NOTIFICATION_MCE 0x06	1681	#define EFI_ACPI_6_0_HARDWARE_ERROR_NOTIFICATION_MCE 0x06
1666	#define EFI_ACPI_6_0_HARDWARE_ERROR_NOTIFICATION_GPIO_SIGNAL 0x07	1682	#define EFI_ACPI_6_0_HARDWARE_ERROR_NOTIFICATION_GPIO_SIGNAL 0x07
1667		1683
1668	///	1684	///
1669	/// Hardware Error Notification Configuration Write Enable Structure Definition	1685	/// Hardware Error Notification Configuration Write Enable Structure Definition
1670	///	1686	///
1671	typedef struct {	1687	typedef struct {
1672	UINT16 Type:1;	1688	UINT16 Type : 1;
1673	UINT16 PollInterval:1;	1689	UINT16 PollInterval : 1;
1674	UINT16 SwitchToPollingThresholdValue:1;	1690	UINT16 SwitchToPollingThresholdValue : 1;
1675	UINT16 SwitchToPollingThresholdWindow:1;	1691	UINT16 SwitchToPollingThresholdWindow : 1;
1676	UINT16 ErrorThresholdValue:1;	1692	UINT16 ErrorThresholdValue : 1;
1677	UINT16 ErrorThresholdWindow:1;	1693	UINT16 ErrorThresholdWindow : 1;
1678	UINT16 Reserved:10;	1694	UINT16 Reserved : 10;
1679	} EFI_ACPI_6_0_HARDWARE_ERROR_NOTIFICATION_CONFIGURATION_WRITE_ENABLE_STRUCTURE;	1695	} EFI_ACPI_6_0_HARDWARE_ERROR_NOTIFICATION_CONFIGURATION_WRITE_ENABLE_STRUCTURE;
1680		1696
1681	///	1697	///
1682	/// Hardware Error Notification Structure Definition	1698	/// Hardware Error Notification Structure Definition
1683	///	1699	///
1684	typedef struct {	1700	typedef struct {
1685	UINT8 Type;	1701	UINT8 Type;
1686	UINT8 Length;	1702	UINT8 Length;
1687	EFI_ACPI_6_0_HARDWARE_ERROR_NOTIFICATION_CONFIGURATION_WRITE_ENABLE_STRUCTURE ConfigurationWriteEnable;	1703	EFI_ACPI_6_0_HARDWARE_ERROR_NOTIFICATION_CONFIGURATION_WRITE_ENABLE_STRUCTURE ConfigurationWriteEnable;
1688	UINT32 PollInterval;	1704	UINT32 PollInterval;
1689	UINT32 Vector;	1705	UINT32 Vector;
1690	UINT32 SwitchToPollingThresholdValue;	1706	UINT32 SwitchToPollingThresholdValue;
1691	UINT32 SwitchToPollingThresholdWindow;	1707	UINT32 SwitchToPollingThresholdWindow;
1692	UINT32 ErrorThresholdValue;	1708	UINT32 ErrorThresholdValue;
1693	UINT32 ErrorThresholdWindow;	1709	UINT32 ErrorThresholdWindow;
1694	} EFI_ACPI_6_0_HARDWARE_ERROR_NOTIFICATION_STRUCTURE;	1710	} EFI_ACPI_6_0_HARDWARE_ERROR_NOTIFICATION_STRUCTURE;
1695		1711
1696	///	1712	///
1697	/// IA-32 Architecture Corrected Machine Check Structure Definition	1713	/// IA-32 Architecture Corrected Machine Check Structure Definition
1698	///	1714	///
1699	typedef struct {	1715	typedef struct {
1700	UINT16 Type;	1716	UINT16 Type;
1701	UINT16 SourceId;	1717	UINT16 SourceId;
1702	UINT8 Reserved0[2];	1718	UINT8 Reserved0[2];
1703	UINT8 Flags;	1719	UINT8 Flags;
1704	UINT8 Enabled;	1720	UINT8 Enabled;
1705	UINT32 NumberOfRecordsToPreAllocate;	1721	UINT32 NumberOfRecordsToPreAllocate;
1706	UINT32 MaxSectionsPerRecord;	1722	UINT32 MaxSectionsPerRecord;
1707	EFI_ACPI_6_0_HARDWARE_ERROR_NOTIFICATION_STRUCTURE NotificationStructure;	1723	EFI_ACPI_6_0_HARDWARE_ERROR_NOTIFICATION_STRUCTURE NotificationStructure;
1708	UINT8 NumberOfHardwareBanks;	1724	UINT8 NumberOfHardwareBanks;
1709	UINT8 Reserved1[3];	1725	UINT8 Reserved1[3];
1710	} EFI_ACPI_6_0_IA32_ARCHITECTURE_CORRECTED_MACHINE_CHECK_STRUCTURE;	1726	} EFI_ACPI_6_0_IA32_ARCHITECTURE_CORRECTED_MACHINE_CHECK_STRUCTURE;
1711		1727
1712	///	1728	///
1713	/// IA-32 Architecture NMI Error Structure Definition	1729	/// IA-32 Architecture NMI Error Structure Definition
1714	///	1730	///
1715	typedef struct {	1731	typedef struct {
1716	UINT16 Type;	1732	UINT16 Type;
1717	UINT16 SourceId;	1733	UINT16 SourceId;
1718	UINT8 Reserved0[2];	1734	UINT8 Reserved0[2];
1719	UINT32 NumberOfRecordsToPreAllocate;	1735	UINT32 NumberOfRecordsToPreAllocate;
1720	UINT32 MaxSectionsPerRecord;	1736	UINT32 MaxSectionsPerRecord;
1721	UINT32 MaxRawDataLength;	1737	UINT32 MaxRawDataLength;
1722	} EFI_ACPI_6_0_IA32_ARCHITECTURE_NMI_ERROR_STRUCTURE;	1738	} EFI_ACPI_6_0_IA32_ARCHITECTURE_NMI_ERROR_STRUCTURE;
1723		1739
1724	///	1740	///
1725	/// PCI Express Root Port AER Structure Definition	1741	/// PCI Express Root Port AER Structure Definition
1726	///	1742	///
1727	typedef struct {	1743	typedef struct {
1728	UINT16 Type;	1744	UINT16 Type;
1729	UINT16 SourceId;	1745	UINT16 SourceId;
1730	UINT8 Reserved0[2];	1746	UINT8 Reserved0[2];
1731	UINT8 Flags;	1747	UINT8 Flags;
1732	UINT8 Enabled;	1748	UINT8 Enabled;
1733	UINT32 NumberOfRecordsToPreAllocate;	1749	UINT32 NumberOfRecordsToPreAllocate;
1734	UINT32 MaxSectionsPerRecord;	1750	UINT32 MaxSectionsPerRecord;
1735	UINT32 Bus;	1751	UINT32 Bus;
1736	UINT16 Device;	1752	UINT16 Device;
1737	UINT16 Function;	1753	UINT16 Function;
1738	UINT16 DeviceControl;	1754	UINT16 DeviceControl;
1739	UINT8 Reserved1[2];	1755	UINT8 Reserved1[2];
1740	UINT32 UncorrectableErrorMask;	1756	UINT32 UncorrectableErrorMask;
1741	UINT32 UncorrectableErrorSeverity;	1757	UINT32 UncorrectableErrorSeverity;
1742	UINT32 CorrectableErrorMask;	1758	UINT32 CorrectableErrorMask;
1743	UINT32 AdvancedErrorCapabilitiesAndControl;	1759	UINT32 AdvancedErrorCapabilitiesAndControl;
1744	UINT32 RootErrorCommand;	1760	UINT32 RootErrorCommand;
1745	} EFI_ACPI_6_0_PCI_EXPRESS_ROOT_PORT_AER_STRUCTURE;	1761	} EFI_ACPI_6_0_PCI_EXPRESS_ROOT_PORT_AER_STRUCTURE;
1746		1762
1747	///	1763	///
1748	/// PCI Express Device AER Structure Definition	1764	/// PCI Express Device AER Structure Definition
1749	///	1765	///
1750	typedef struct {	1766	typedef struct {
1751	UINT16 Type;	1767	UINT16 Type;
1752	UINT16 SourceId;	1768	UINT16 SourceId;
1753	UINT8 Reserved0[2];	1769	UINT8 Reserved0[2];
1754	UINT8 Flags;	1770	UINT8 Flags;
1755	UINT8 Enabled;	1771	UINT8 Enabled;
1756	UINT32 NumberOfRecordsToPreAllocate;	1772	UINT32 NumberOfRecordsToPreAllocate;
1757	UINT32 MaxSectionsPerRecord;	1773	UINT32 MaxSectionsPerRecord;
1758	UINT32 Bus;	1774	UINT32 Bus;
1759	UINT16 Device;	1775	UINT16 Device;
1760	UINT16 Function;	1776	UINT16 Function;
1761	UINT16 DeviceControl;	1777	UINT16 DeviceControl;
1762	UINT8 Reserved1[2];	1778	UINT8 Reserved1[2];
1763	UINT32 UncorrectableErrorMask;	1779	UINT32 UncorrectableErrorMask;
1764	UINT32 UncorrectableErrorSeverity;	1780	UINT32 UncorrectableErrorSeverity;
1765	UINT32 CorrectableErrorMask;	1781	UINT32 CorrectableErrorMask;
1766	UINT32 AdvancedErrorCapabilitiesAndControl;	1782	UINT32 AdvancedErrorCapabilitiesAndControl;
1767	} EFI_ACPI_6_0_PCI_EXPRESS_DEVICE_AER_STRUCTURE;	1783	} EFI_ACPI_6_0_PCI_EXPRESS_DEVICE_AER_STRUCTURE;
1768		1784
1769	///	1785	///
1770	/// PCI Express Bridge AER Structure Definition	1786	/// PCI Express Bridge AER Structure Definition
1771	///	1787	///
1772	typedef struct {	1788	typedef struct {
1773	UINT16 Type;	1789	UINT16 Type;
1774	UINT16 SourceId;	1790	UINT16 SourceId;
1775	UINT8 Reserved0[2];	1791	UINT8 Reserved0[2];
1776	UINT8 Flags;	1792	UINT8 Flags;
1777	UINT8 Enabled;	1793	UINT8 Enabled;
1778	UINT32 NumberOfRecordsToPreAllocate;	1794	UINT32 NumberOfRecordsToPreAllocate;
1779	UINT32 MaxSectionsPerRecord;	1795	UINT32 MaxSectionsPerRecord;
1780	UINT32 Bus;	1796	UINT32 Bus;
1781	UINT16 Device;	1797	UINT16 Device;
1782	UINT16 Function;	1798	UINT16 Function;
1783	UINT16 DeviceControl;	1799	UINT16 DeviceControl;
1784	UINT8 Reserved1[2];	1800	UINT8 Reserved1[2];
1785	UINT32 UncorrectableErrorMask;	1801	UINT32 UncorrectableErrorMask;
1786	UINT32 UncorrectableErrorSeverity;	1802	UINT32 UncorrectableErrorSeverity;
1787	UINT32 CorrectableErrorMask;	1803	UINT32 CorrectableErrorMask;
1788	UINT32 AdvancedErrorCapabilitiesAndControl;	1804	UINT32 AdvancedErrorCapabilitiesAndControl;
1789	UINT32 SecondaryUncorrectableErrorMask;	1805	UINT32 SecondaryUncorrectableErrorMask;
1790	UINT32 SecondaryUncorrectableErrorSeverity;	1806	UINT32 SecondaryUncorrectableErrorSeverity;
1791	UINT32 SecondaryAdvancedErrorCapabilitiesAndControl;	1807	UINT32 SecondaryAdvancedErrorCapabilitiesAndControl;
1792	} EFI_ACPI_6_0_PCI_EXPRESS_BRIDGE_AER_STRUCTURE;	1808	} EFI_ACPI_6_0_PCI_EXPRESS_BRIDGE_AER_STRUCTURE;
1793		1809
1794	///	1810	///
1795	/// Generic Hardware Error Source Structure Definition	1811	/// Generic Hardware Error Source Structure Definition
1796	///	1812	///
1797	typedef struct {	1813	typedef struct {
1798	UINT16 Type;	1814	UINT16 Type;
1799	UINT16 SourceId;	1815	UINT16 SourceId;
1800	UINT16 RelatedSourceId;	1816	UINT16 RelatedSourceId;
1801	UINT8 Flags;	1817	UINT8 Flags;
1802	UINT8 Enabled;	1818	UINT8 Enabled;
1803	UINT32 NumberOfRecordsToPreAllocate;	1819	UINT32 NumberOfRecordsToPreAllocate;
1804	UINT32 MaxSectionsPerRecord;	1820	UINT32 MaxSectionsPerRecord;
1805	UINT32 MaxRawDataLength;	1821	UINT32 MaxRawDataLength;
1806	EFI_ACPI_6_0_GENERIC_ADDRESS_STRUCTURE ErrorStatusAddress;	1822	EFI_ACPI_6_0_GENERIC_ADDRESS_STRUCTURE ErrorStatusAddress;
1807	EFI_ACPI_6_0_HARDWARE_ERROR_NOTIFICATION_STRUCTURE NotificationStructure;	1823	EFI_ACPI_6_0_HARDWARE_ERROR_NOTIFICATION_STRUCTURE NotificationStructure;
1808	UINT32 ErrorStatusBlockLength;	1824	UINT32 ErrorStatusBlockLength;
1809	} EFI_ACPI_6_0_GENERIC_HARDWARE_ERROR_SOURCE_STRUCTURE;	1825	} EFI_ACPI_6_0_GENERIC_HARDWARE_ERROR_SOURCE_STRUCTURE;
1810		1826
1811	///	1827	///
1812	/// Generic Error Status Definition	1828	/// Generic Error Status Definition
1813	///	1829	///
1814	typedef struct {	1830	typedef struct {
1815	EFI_ACPI_6_0_ERROR_BLOCK_STATUS BlockStatus;	1831	EFI_ACPI_6_0_ERROR_BLOCK_STATUS BlockStatus;
1816	UINT32 RawDataOffset;	1832	UINT32 RawDataOffset;
1817	UINT32 RawDataLength;	1833	UINT32 RawDataLength;
1818	UINT32 DataLength;	1834	UINT32 DataLength;
1819	UINT32 ErrorSeverity;	1835	UINT32 ErrorSeverity;
1820	} EFI_ACPI_6_0_GENERIC_ERROR_STATUS_STRUCTURE;	1836	} EFI_ACPI_6_0_GENERIC_ERROR_STATUS_STRUCTURE;
1821		1837
1822	///	1838	///
1823	/// ERST - Error Record Serialization Table	1839	/// ERST - Error Record Serialization Table
1824	///	1840	///
1825	typedef struct {	1841	typedef struct {
1826	EFI_ACPI_DESCRIPTION_HEADER Header;	1842	EFI_ACPI_DESCRIPTION_HEADER Header;
1827	UINT32 SerializationHeaderSize;	1843	UINT32 SerializationHeaderSize;
1828	UINT8 Reserved0[4];	1844	UINT8 Reserved0[4];
1829	UINT32 InstructionEntryCount;	1845	UINT32 InstructionEntryCount;
1830	} EFI_ACPI_6_0_ERROR_RECORD_SERIALIZATION_TABLE_HEADER;	1846	} EFI_ACPI_6_0_ERROR_RECORD_SERIALIZATION_TABLE_HEADER;
1831		1847
1832	///	1848	///
1833	/// ERST Version (as defined in ACPI 6.0 spec.)	1849	/// ERST Version (as defined in ACPI 6.0 spec.)
1834	///	1850	///
1835	#define EFI_ACPI_6_0_ERROR_RECORD_SERIALIZATION_TABLE_REVISION 0x01	1851	#define EFI_ACPI_6_0_ERROR_RECORD_SERIALIZATION_TABLE_REVISION 0x01
1836		1852
1837	///	1853	///
1838	/// ERST Serialization Actions	1854	/// ERST Serialization Actions
1839	///	1855	///
1840	#define EFI_ACPI_6_0_ERST_BEGIN_WRITE_OPERATION 0x00	1856	#define EFI_ACPI_6_0_ERST_BEGIN_WRITE_OPERATION 0x00
1841	#define EFI_ACPI_6_0_ERST_BEGIN_READ_OPERATION 0x01	1857	#define EFI_ACPI_6_0_ERST_BEGIN_READ_OPERATION 0x01
1842	#define EFI_ACPI_6_0_ERST_BEGIN_CLEAR_OPERATION 0x02	1858	#define EFI_ACPI_6_0_ERST_BEGIN_CLEAR_OPERATION 0x02
1843	#define EFI_ACPI_6_0_ERST_END_OPERATION 0x03	1859	#define EFI_ACPI_6_0_ERST_END_OPERATION 0x03
1844	#define EFI_ACPI_6_0_ERST_SET_RECORD_OFFSET 0x04	1860	#define EFI_ACPI_6_0_ERST_SET_RECORD_OFFSET 0x04
1845	#define EFI_ACPI_6_0_ERST_EXECUTE_OPERATION 0x05	1861	#define EFI_ACPI_6_0_ERST_EXECUTE_OPERATION 0x05
1846	#define EFI_ACPI_6_0_ERST_CHECK_BUSY_STATUS 0x06	1862	#define EFI_ACPI_6_0_ERST_CHECK_BUSY_STATUS 0x06
1847	#define EFI_ACPI_6_0_ERST_GET_COMMAND_STATUS 0x07	1863	#define EFI_ACPI_6_0_ERST_GET_COMMAND_STATUS 0x07
1848	#define EFI_ACPI_6_0_ERST_GET_RECORD_IDENTIFIER 0x08	1864	#define EFI_ACPI_6_0_ERST_GET_RECORD_IDENTIFIER 0x08
1849	#define EFI_ACPI_6_0_ERST_SET_RECORD_IDENTIFIER 0x09	1865	#define EFI_ACPI_6_0_ERST_SET_RECORD_IDENTIFIER 0x09
1850	#define EFI_ACPI_6_0_ERST_GET_RECORD_COUNT 0x0A	1866	#define EFI_ACPI_6_0_ERST_GET_RECORD_COUNT 0x0A
1851	#define EFI_ACPI_6_0_ERST_BEGIN_DUMMY_WRITE_OPERATION 0x0B	1867	#define EFI_ACPI_6_0_ERST_BEGIN_DUMMY_WRITE_OPERATION 0x0B
1852	#define EFI_ACPI_6_0_ERST_GET_ERROR_LOG_ADDRESS_RANGE 0x0D	1868	#define EFI_ACPI_6_0_ERST_GET_ERROR_LOG_ADDRESS_RANGE 0x0D
1853	#define EFI_ACPI_6_0_ERST_GET_ERROR_LOG_ADDRESS_RANGE_LENGTH 0x0E	1869	#define EFI_ACPI_6_0_ERST_GET_ERROR_LOG_ADDRESS_RANGE_LENGTH 0x0E
1854	#define EFI_ACPI_6_0_ERST_GET_ERROR_LOG_ADDRESS_RANGE_ATTRIBUTES 0x0F	1870	#define EFI_ACPI_6_0_ERST_GET_ERROR_LOG_ADDRESS_RANGE_ATTRIBUTES 0x0F
1855		1871
1856	///	1872	///
1857	/// ERST Action Command Status	1873	/// ERST Action Command Status
1858	///	1874	///
1859	#define EFI_ACPI_6_0_ERST_STATUS_SUCCESS 0x00	1875	#define EFI_ACPI_6_0_ERST_STATUS_SUCCESS 0x00
1860	#define EFI_ACPI_6_0_ERST_STATUS_NOT_ENOUGH_SPACE 0x01	1876	#define EFI_ACPI_6_0_ERST_STATUS_NOT_ENOUGH_SPACE 0x01
1861	#define EFI_ACPI_6_0_ERST_STATUS_HARDWARE_NOT_AVAILABLE 0x02	1877	#define EFI_ACPI_6_0_ERST_STATUS_HARDWARE_NOT_AVAILABLE 0x02
1862	#define EFI_ACPI_6_0_ERST_STATUS_FAILED 0x03	1878	#define EFI_ACPI_6_0_ERST_STATUS_FAILED 0x03
1863	#define EFI_ACPI_6_0_ERST_STATUS_RECORD_STORE_EMPTY 0x04	1879	#define EFI_ACPI_6_0_ERST_STATUS_RECORD_STORE_EMPTY 0x04
1864	#define EFI_ACPI_6_0_ERST_STATUS_RECORD_NOT_FOUND 0x05	1880	#define EFI_ACPI_6_0_ERST_STATUS_RECORD_NOT_FOUND 0x05
1865		1881
1866	///	1882	///
1867	/// ERST Serialization Instructions	1883	/// ERST Serialization Instructions
1868	///	1884	///
1869	#define EFI_ACPI_6_0_ERST_READ_REGISTER 0x00	1885	#define EFI_ACPI_6_0_ERST_READ_REGISTER 0x00
1870	#define EFI_ACPI_6_0_ERST_READ_REGISTER_VALUE 0x01	1886	#define EFI_ACPI_6_0_ERST_READ_REGISTER_VALUE 0x01
1871	#define EFI_ACPI_6_0_ERST_WRITE_REGISTER 0x02	1887	#define EFI_ACPI_6_0_ERST_WRITE_REGISTER 0x02
1872	#define EFI_ACPI_6_0_ERST_WRITE_REGISTER_VALUE 0x03	1888	#define EFI_ACPI_6_0_ERST_WRITE_REGISTER_VALUE 0x03
1873	#define EFI_ACPI_6_0_ERST_NOOP 0x04	1889	#define EFI_ACPI_6_0_ERST_NOOP 0x04
1874	#define EFI_ACPI_6_0_ERST_LOAD_VAR1 0x05	1890	#define EFI_ACPI_6_0_ERST_LOAD_VAR1 0x05
1875	#define EFI_ACPI_6_0_ERST_LOAD_VAR2 0x06	1891	#define EFI_ACPI_6_0_ERST_LOAD_VAR2 0x06
1876	#define EFI_ACPI_6_0_ERST_STORE_VAR1 0x07	1892	#define EFI_ACPI_6_0_ERST_STORE_VAR1 0x07
1877	#define EFI_ACPI_6_0_ERST_ADD 0x08	1893	#define EFI_ACPI_6_0_ERST_ADD 0x08
1878	#define EFI_ACPI_6_0_ERST_SUBTRACT 0x09	1894	#define EFI_ACPI_6_0_ERST_SUBTRACT 0x09
1879	#define EFI_ACPI_6_0_ERST_ADD_VALUE 0x0A	1895	#define EFI_ACPI_6_0_ERST_ADD_VALUE 0x0A
1880	#define EFI_ACPI_6_0_ERST_SUBTRACT_VALUE 0x0B	1896	#define EFI_ACPI_6_0_ERST_SUBTRACT_VALUE 0x0B
1881	#define EFI_ACPI_6_0_ERST_STALL 0x0C	1897	#define EFI_ACPI_6_0_ERST_STALL 0x0C
1882	#define EFI_ACPI_6_0_ERST_STALL_WHILE_TRUE 0x0D	1898	#define EFI_ACPI_6_0_ERST_STALL_WHILE_TRUE 0x0D
1883	#define EFI_ACPI_6_0_ERST_SKIP_NEXT_INSTRUCTION_IF_TRUE 0x0E	1899	#define EFI_ACPI_6_0_ERST_SKIP_NEXT_INSTRUCTION_IF_TRUE 0x0E
1884	#define EFI_ACPI_6_0_ERST_GOTO 0x0F	1900	#define EFI_ACPI_6_0_ERST_GOTO 0x0F
1885	#define EFI_ACPI_6_0_ERST_SET_SRC_ADDRESS_BASE 0x10	1901	#define EFI_ACPI_6_0_ERST_SET_SRC_ADDRESS_BASE 0x10
1886	#define EFI_ACPI_6_0_ERST_SET_DST_ADDRESS_BASE 0x11	1902	#define EFI_ACPI_6_0_ERST_SET_DST_ADDRESS_BASE 0x11
1887	#define EFI_ACPI_6_0_ERST_MOVE_DATA 0x12	1903	#define EFI_ACPI_6_0_ERST_MOVE_DATA 0x12
1888		1904
1889	///	1905	///
1890	/// ERST Instruction Flags	1906	/// ERST Instruction Flags
1891	///	1907	///
1892	#define EFI_ACPI_6_0_ERST_PRESERVE_REGISTER 0x01	1908	#define EFI_ACPI_6_0_ERST_PRESERVE_REGISTER 0x01
1893		1909
1894	///	1910	///
1895	/// ERST Serialization Instruction Entry	1911	/// ERST Serialization Instruction Entry
1896	///	1912	///
1897	typedef struct {	1913	typedef struct {
1898	UINT8 SerializationAction;	1914	UINT8 SerializationAction;
1899	UINT8 Instruction;	1915	UINT8 Instruction;
1900	UINT8 Flags;	1916	UINT8 Flags;
1901	UINT8 Reserved0;	1917	UINT8 Reserved0;
1902	EFI_ACPI_6_0_GENERIC_ADDRESS_STRUCTURE RegisterRegion;	1918	EFI_ACPI_6_0_GENERIC_ADDRESS_STRUCTURE RegisterRegion;
1903	UINT64 Value;	1919	UINT64 Value;
1904	UINT64 Mask;	1920	UINT64 Mask;
1905	} EFI_ACPI_6_0_ERST_SERIALIZATION_INSTRUCTION_ENTRY;	1921	} EFI_ACPI_6_0_ERST_SERIALIZATION_INSTRUCTION_ENTRY;
1906		1922
1907	///	1923	///
1908	/// EINJ - Error Injection Table	1924	/// EINJ - Error Injection Table
1909	///	1925	///
1910	typedef struct {	1926	typedef struct {
1911	EFI_ACPI_DESCRIPTION_HEADER Header;	1927	EFI_ACPI_DESCRIPTION_HEADER Header;
1912	UINT32 InjectionHeaderSize;	1928	UINT32 InjectionHeaderSize;
1913	UINT8 InjectionFlags;	1929	UINT8 InjectionFlags;
1914	UINT8 Reserved0[3];	1930	UINT8 Reserved0[3];
1915	UINT32 InjectionEntryCount;	1931	UINT32 InjectionEntryCount;
1916	} EFI_ACPI_6_0_ERROR_INJECTION_TABLE_HEADER;	1932	} EFI_ACPI_6_0_ERROR_INJECTION_TABLE_HEADER;
1917		1933
1918	///	1934	///
1919	/// EINJ Version (as defined in ACPI 6.0 spec.)	1935	/// EINJ Version (as defined in ACPI 6.0 spec.)
1920	///	1936	///
1921	#define EFI_ACPI_6_0_ERROR_INJECTION_TABLE_REVISION 0x01	1937	#define EFI_ACPI_6_0_ERROR_INJECTION_TABLE_REVISION 0x01
1922		1938
1923	///	1939	///
1924	/// EINJ Error Injection Actions	1940	/// EINJ Error Injection Actions
1925	///	1941	///
1926	#define EFI_ACPI_6_0_EINJ_BEGIN_INJECTION_OPERATION 0x00	1942	#define EFI_ACPI_6_0_EINJ_BEGIN_INJECTION_OPERATION 0x00
1927	#define EFI_ACPI_6_0_EINJ_GET_TRIGGER_ERROR_ACTION_TABLE 0x01	1943	#define EFI_ACPI_6_0_EINJ_GET_TRIGGER_ERROR_ACTION_TABLE 0x01
1928	#define EFI_ACPI_6_0_EINJ_SET_ERROR_TYPE 0x02	1944	#define EFI_ACPI_6_0_EINJ_SET_ERROR_TYPE 0x02
1929	#define EFI_ACPI_6_0_EINJ_GET_ERROR_TYPE 0x03	1945	#define EFI_ACPI_6_0_EINJ_GET_ERROR_TYPE 0x03
1930	#define EFI_ACPI_6_0_EINJ_END_OPERATION 0x04	1946	#define EFI_ACPI_6_0_EINJ_END_OPERATION 0x04
1931	#define EFI_ACPI_6_0_EINJ_EXECUTE_OPERATION 0x05	1947	#define EFI_ACPI_6_0_EINJ_EXECUTE_OPERATION 0x05
1932	#define EFI_ACPI_6_0_EINJ_CHECK_BUSY_STATUS 0x06	1948	#define EFI_ACPI_6_0_EINJ_CHECK_BUSY_STATUS 0x06
1933	#define EFI_ACPI_6_0_EINJ_GET_COMMAND_STATUS 0x07	1949	#define EFI_ACPI_6_0_EINJ_GET_COMMAND_STATUS 0x07
1934	#define EFI_ACPI_6_0_EINJ_TRIGGER_ERROR 0xFF	1950	#define EFI_ACPI_6_0_EINJ_TRIGGER_ERROR 0xFF
1935		1951
1936	///	1952	///
1937	/// EINJ Action Command Status	1953	/// EINJ Action Command Status
1938	///	1954	///
1939	#define EFI_ACPI_6_0_EINJ_STATUS_SUCCESS 0x00	1955	#define EFI_ACPI_6_0_EINJ_STATUS_SUCCESS 0x00
1940	#define EFI_ACPI_6_0_EINJ_STATUS_UNKNOWN_FAILURE 0x01	1956	#define EFI_ACPI_6_0_EINJ_STATUS_UNKNOWN_FAILURE 0x01
1941	#define EFI_ACPI_6_0_EINJ_STATUS_INVALID_ACCESS 0x02	1957	#define EFI_ACPI_6_0_EINJ_STATUS_INVALID_ACCESS 0x02
1942		1958
1943	///	1959	///
1944	/// EINJ Error Type Definition	1960	/// EINJ Error Type Definition
1945	///	1961	///
1946	#define EFI_ACPI_6_0_EINJ_ERROR_PROCESSOR_CORRECTABLE (1 << 0)	1962	#define EFI_ACPI_6_0_EINJ_ERROR_PROCESSOR_CORRECTABLE (1 << 0)
1947	#define EFI_ACPI_6_0_EINJ_ERROR_PROCESSOR_UNCORRECTABLE_NONFATAL (1 << 1)	1963	#define EFI_ACPI_6_0_EINJ_ERROR_PROCESSOR_UNCORRECTABLE_NONFATAL (1 << 1)
1948	#define EFI_ACPI_6_0_EINJ_ERROR_PROCESSOR_UNCORRECTABLE_FATAL (1 << 2)	1964	#define EFI_ACPI_6_0_EINJ_ERROR_PROCESSOR_UNCORRECTABLE_FATAL (1 << 2)
1949	#define EFI_ACPI_6_0_EINJ_ERROR_MEMORY_CORRECTABLE (1 << 3)	1965	#define EFI_ACPI_6_0_EINJ_ERROR_MEMORY_CORRECTABLE (1 << 3)
1950	#define EFI_ACPI_6_0_EINJ_ERROR_MEMORY_UNCORRECTABLE_NONFATAL (1 << 4)	1966	#define EFI_ACPI_6_0_EINJ_ERROR_MEMORY_UNCORRECTABLE_NONFATAL (1 << 4)
1951	#define EFI_ACPI_6_0_EINJ_ERROR_MEMORY_UNCORRECTABLE_FATAL (1 << 5)	1967	#define EFI_ACPI_6_0_EINJ_ERROR_MEMORY_UNCORRECTABLE_FATAL (1 << 5)
1952	#define EFI_ACPI_6_0_EINJ_ERROR_PCI_EXPRESS_CORRECTABLE (1 << 6)	1968	#define EFI_ACPI_6_0_EINJ_ERROR_PCI_EXPRESS_CORRECTABLE (1 << 6)
1953	#define EFI_ACPI_6_0_EINJ_ERROR_PCI_EXPRESS_UNCORRECTABLE_NONFATAL (1 << 7)	1969	#define EFI_ACPI_6_0_EINJ_ERROR_PCI_EXPRESS_UNCORRECTABLE_NONFATAL (1 << 7)
1954	#define EFI_ACPI_6_0_EINJ_ERROR_PCI_EXPRESS_UNCORRECTABLE_FATAL (1 << 8)	1970	#define EFI_ACPI_6_0_EINJ_ERROR_PCI_EXPRESS_UNCORRECTABLE_FATAL (1 << 8)
1955	#define EFI_ACPI_6_0_EINJ_ERROR_PLATFORM_CORRECTABLE (1 << 9)	1971	#define EFI_ACPI_6_0_EINJ_ERROR_PLATFORM_CORRECTABLE (1 << 9)
1956	#define EFI_ACPI_6_0_EINJ_ERROR_PLATFORM_UNCORRECTABLE_NONFATAL (1 << 10)	1972	#define EFI_ACPI_6_0_EINJ_ERROR_PLATFORM_UNCORRECTABLE_NONFATAL (1 << 10)
1957	#define EFI_ACPI_6_0_EINJ_ERROR_PLATFORM_UNCORRECTABLE_FATAL (1 << 11)	1973	#define EFI_ACPI_6_0_EINJ_ERROR_PLATFORM_UNCORRECTABLE_FATAL (1 << 11)
1958		1974
1959	///	1975	///
1960	/// EINJ Injection Instructions	1976	/// EINJ Injection Instructions
1961	///	1977	///
1962	#define EFI_ACPI_6_0_EINJ_READ_REGISTER 0x00	1978	#define EFI_ACPI_6_0_EINJ_READ_REGISTER 0x00
1963	#define EFI_ACPI_6_0_EINJ_READ_REGISTER_VALUE 0x01	1979	#define EFI_ACPI_6_0_EINJ_READ_REGISTER_VALUE 0x01
1964	#define EFI_ACPI_6_0_EINJ_WRITE_REGISTER 0x02	1980	#define EFI_ACPI_6_0_EINJ_WRITE_REGISTER 0x02
1965	#define EFI_ACPI_6_0_EINJ_WRITE_REGISTER_VALUE 0x03	1981	#define EFI_ACPI_6_0_EINJ_WRITE_REGISTER_VALUE 0x03
1966	#define EFI_ACPI_6_0_EINJ_NOOP 0x04	1982	#define EFI_ACPI_6_0_EINJ_NOOP 0x04
1967		1983
1968	///	1984	///
1969	/// EINJ Instruction Flags	1985	/// EINJ Instruction Flags
1970	///	1986	///
1971	#define EFI_ACPI_6_0_EINJ_PRESERVE_REGISTER 0x01	1987	#define EFI_ACPI_6_0_EINJ_PRESERVE_REGISTER 0x01
1972		1988
1973	///	1989	///
1974	/// EINJ Injection Instruction Entry	1990	/// EINJ Injection Instruction Entry
1975	///	1991	///
1976	typedef struct {	1992	typedef struct {
1977	UINT8 InjectionAction;	1993	UINT8 InjectionAction;
1978	UINT8 Instruction;	1994	UINT8 Instruction;
1979	UINT8 Flags;	1995	UINT8 Flags;
1980	UINT8 Reserved0;	1996	UINT8 Reserved0;
1981	EFI_ACPI_6_0_GENERIC_ADDRESS_STRUCTURE RegisterRegion;	1997	EFI_ACPI_6_0_GENERIC_ADDRESS_STRUCTURE RegisterRegion;
1982	UINT64 Value;	1998	UINT64 Value;
1983	UINT64 Mask;	1999	UINT64 Mask;
1984	} EFI_ACPI_6_0_EINJ_INJECTION_INSTRUCTION_ENTRY;	2000	} EFI_ACPI_6_0_EINJ_INJECTION_INSTRUCTION_ENTRY;
1985		2001
1986	///	2002	///
1987	/// EINJ Trigger Action Table	2003	/// EINJ Trigger Action Table
1988	///	2004	///
1989	typedef struct {	2005	typedef struct {
1990	UINT32 HeaderSize;	2006	UINT32 HeaderSize;
1991	UINT32 Revision;	2007	UINT32 Revision;
1992	UINT32 TableSize;	2008	UINT32 TableSize;
1993	UINT32 EntryCount;	2009	UINT32 EntryCount;
1994	} EFI_ACPI_6_0_EINJ_TRIGGER_ACTION_TABLE;	2010	} EFI_ACPI_6_0_EINJ_TRIGGER_ACTION_TABLE;
1995		2011
1996	///	2012	///
1997	/// Platform Communications Channel Table (PCCT)	2013	/// Platform Communications Channel Table (PCCT)
1998	///	2014	///
1999	typedef struct {	2015	typedef struct {
2000	EFI_ACPI_DESCRIPTION_HEADER Header;	2016	EFI_ACPI_DESCRIPTION_HEADER Header;
2001	UINT32 Flags;	2017	UINT32 Flags;
2002	UINT64 Reserved;	2018	UINT64 Reserved;
2003	} EFI_ACPI_6_0_PLATFORM_COMMUNICATION_CHANNEL_TABLE_HEADER;	2019	} EFI_ACPI_6_0_PLATFORM_COMMUNICATION_CHANNEL_TABLE_HEADER;
2004		2020
2005	///	2021	///
2006	/// PCCT Version (as defined in ACPI 6.0 spec.)	2022	/// PCCT Version (as defined in ACPI 6.0 spec.)
2007	///	2023	///
2008	#define EFI_ACPI_6_0_PLATFORM_COMMUNICATION_CHANNEL_TABLE_REVISION 0x01	2024	#define EFI_ACPI_6_0_PLATFORM_COMMUNICATION_CHANNEL_TABLE_REVISION 0x01
2009		2025
2010	///	2026	///
2011	/// PCCT Global Flags	2027	/// PCCT Global Flags
2012	///	2028	///
2013	#define EFI_ACPI_6_0_PCCT_FLAGS_SCI_DOORBELL BIT0	2029	#define EFI_ACPI_6_0_PCCT_FLAGS_SCI_DOORBELL BIT0
2014		2030
2015	//	2031	//
2016	// PCCT Subspace type	2032	// PCCT Subspace type
2017	//	2033	//
2018	#define EFI_ACPI_6_0_PCCT_SUBSPACE_TYPE_GENERIC 0x00	2034	#define EFI_ACPI_6_0_PCCT_SUBSPACE_TYPE_GENERIC 0x00
2019	#define EFI_ACPI_6_0_PCCT_SUBSPACE_TYPE_1_HW_REDUCED_COMMUNICATIONS 0x01	2035	#define EFI_ACPI_6_0_PCCT_SUBSPACE_TYPE_1_HW_REDUCED_COMMUNICATIONS 0x01
2020	#define EFI_ACPI_6_0_PCCT_SUBSPACE_TYPE_2_HW_REDUCED_COMMUNICATIONS 0x02	2036	#define EFI_ACPI_6_0_PCCT_SUBSPACE_TYPE_2_HW_REDUCED_COMMUNICATIONS 0x02
2021		2037
2022	///	2038	///
2023	/// PCC Subspace Structure Header	2039	/// PCC Subspace Structure Header
2024	///	2040	///
2025	typedef struct {	2041	typedef struct {
2026	UINT8 Type;	2042	UINT8 Type;
2027	UINT8 Length;	2043	UINT8 Length;
2028	} EFI_ACPI_6_0_PCCT_SUBSPACE_HEADER;	2044	} EFI_ACPI_6_0_PCCT_SUBSPACE_HEADER;
2029		2045
2030	///	2046	///
2031	/// Generic Communications Subspace Structure	2047	/// Generic Communications Subspace Structure
2032	///	2048	///
2033	typedef struct {	2049	typedef struct {
2034	UINT8 Type;	2050	UINT8 Type;
2035	UINT8 Length;	2051	UINT8 Length;
2036	UINT8 Reserved[6];	2052	UINT8 Reserved[6];
2037	UINT64 BaseAddress;	2053	UINT64 BaseAddress;
2038	UINT64 AddressLength;	2054	UINT64 AddressLength;
2039	EFI_ACPI_6_0_GENERIC_ADDRESS_STRUCTURE DoorbellRegister;	2055	EFI_ACPI_6_0_GENERIC_ADDRESS_STRUCTURE DoorbellRegister;
2040	UINT64 DoorbellPreserve;	2056	UINT64 DoorbellPreserve;
2041	UINT64 DoorbellWrite;	2057	UINT64 DoorbellWrite;
2042	UINT32 NominalLatency;	2058	UINT32 NominalLatency;
2043	UINT32 MaximumPeriodicAccessRate;	2059	UINT32 MaximumPeriodicAccessRate;
2044	UINT16 MinimumRequestTurnaroundTime;	2060	UINT16 MinimumRequestTurnaroundTime;
2045	} EFI_ACPI_6_0_PCCT_SUBSPACE_GENERIC;	2061	} EFI_ACPI_6_0_PCCT_SUBSPACE_GENERIC;
2046		2062
2047	///	2063	///
Lines 2049-2066 typedef struct { Link Here
2049	///	2065	///
2050		2066
2051	typedef struct {	2067	typedef struct {
2052	UINT8 Command;	2068	UINT8 Command;
2053	UINT8 Reserved:7;	2069	UINT8 Reserved : 7;
2054	UINT8 GenerateSci:1;	2070	UINT8 GenerateSci : 1;
2055	} EFI_ACPI_6_0_PCCT_GENERIC_SHARED_MEMORY_REGION_COMMAND;	2071	} EFI_ACPI_6_0_PCCT_GENERIC_SHARED_MEMORY_REGION_COMMAND;
2056		2072
2057	typedef struct {	2073	typedef struct {
2058	UINT8 CommandComplete:1;	2074	UINT8 CommandComplete : 1;
2059	UINT8 SciDoorbell:1;	2075	UINT8 SciDoorbell : 1;
2060	UINT8 Error:1;	2076	UINT8 Error : 1;
2061	UINT8 PlatformNotification:1;	2077	UINT8 PlatformNotification : 1;
2062	UINT8 Reserved:4;	2078	UINT8 Reserved : 4;
2063	UINT8 Reserved1;	2079	UINT8 Reserved1;
2064	} EFI_ACPI_6_0_PCCT_GENERIC_SHARED_MEMORY_REGION_STATUS;	2080	} EFI_ACPI_6_0_PCCT_GENERIC_SHARED_MEMORY_REGION_STATUS;
2065		2081
2066	typedef struct {	2082	typedef struct {
Lines 2069-2116 typedef struct { Link Here
2069	EFI_ACPI_6_0_PCCT_GENERIC_SHARED_MEMORY_REGION_STATUS Status;	2085	EFI_ACPI_6_0_PCCT_GENERIC_SHARED_MEMORY_REGION_STATUS Status;
2070	} EFI_ACPI_6_0_PCCT_GENERIC_SHARED_MEMORY_REGION_HEADER;	2086	} EFI_ACPI_6_0_PCCT_GENERIC_SHARED_MEMORY_REGION_HEADER;
2071		2087
2072	#define EFI_ACPI_6_0_PCCT_SUBSPACE_DOORBELL_INTERRUPT_FLAGS_POLARITY BIT0	2088	#define EFI_ACPI_6_0_PCCT_SUBSPACE_DOORBELL_INTERRUPT_FLAGS_POLARITY BIT0
2073	#define EFI_ACPI_6_0_PCCT_SUBSPACE_DOORBELL_INTERRUPT_FLAGS_MODE BIT1	2089	#define EFI_ACPI_6_0_PCCT_SUBSPACE_DOORBELL_INTERRUPT_FLAGS_MODE BIT1
2074		2090
2075	///	2091	///
2076	/// Type 1 HW-Reduced Communications Subspace Structure	2092	/// Type 1 HW-Reduced Communications Subspace Structure
2077	///	2093	///
2078	typedef struct {	2094	typedef struct {
2079	UINT8 Type;	2095	UINT8 Type;
2080	UINT8 Length;	2096	UINT8 Length;
2081	UINT32 DoorbellInterrupt;	2097	UINT32 DoorbellInterrupt;
2082	UINT8 DoorbellInterruptFlags;	2098	UINT8 DoorbellInterruptFlags;
2083	UINT8 Reserved;	2099	UINT8 Reserved;
2084	UINT64 BaseAddress;	2100	UINT64 BaseAddress;
2085	UINT64 AddressLength;	2101	UINT64 AddressLength;
2086	EFI_ACPI_6_0_GENERIC_ADDRESS_STRUCTURE DoorbellRegister;	2102	EFI_ACPI_6_0_GENERIC_ADDRESS_STRUCTURE DoorbellRegister;
2087	UINT64 DoorbellPreserve;	2103	UINT64 DoorbellPreserve;
2088	UINT64 DoorbellWrite;	2104	UINT64 DoorbellWrite;
2089	UINT32 NominalLatency;	2105	UINT32 NominalLatency;
2090	UINT32 MaximumPeriodicAccessRate;	2106	UINT32 MaximumPeriodicAccessRate;
2091	UINT16 MinimumRequestTurnaroundTime;	2107	UINT16 MinimumRequestTurnaroundTime;
2092	} EFI_ACPI_6_0_PCCT_SUBSPACE_1_HW_REDUCED_COMMUNICATIONS;	2108	} EFI_ACPI_6_0_PCCT_SUBSPACE_1_HW_REDUCED_COMMUNICATIONS;
2093		2109
2094	///	2110	///
2095	/// Type 2 HW-Reduced Communications Subspace Structure	2111	/// Type 2 HW-Reduced Communications Subspace Structure
2096	///	2112	///
2097	typedef struct {	2113	typedef struct {
2098	UINT8 Type;	2114	UINT8 Type;
2099	UINT8 Length;	2115	UINT8 Length;
2100	UINT32 DoorbellInterrupt;	2116	UINT32 DoorbellInterrupt;
2101	UINT8 DoorbellInterruptFlags;	2117	UINT8 DoorbellInterruptFlags;
2102	UINT8 Reserved;	2118	UINT8 Reserved;
2103	UINT64 BaseAddress;	2119	UINT64 BaseAddress;
2104	UINT64 AddressLength;	2120	UINT64 AddressLength;
2105	EFI_ACPI_6_0_GENERIC_ADDRESS_STRUCTURE DoorbellRegister;	2121	EFI_ACPI_6_0_GENERIC_ADDRESS_STRUCTURE DoorbellRegister;
2106	UINT64 DoorbellPreserve;	2122	UINT64 DoorbellPreserve;
2107	UINT64 DoorbellWrite;	2123	UINT64 DoorbellWrite;
2108	UINT32 NominalLatency;	2124	UINT32 NominalLatency;
2109	UINT32 MaximumPeriodicAccessRate;	2125	UINT32 MaximumPeriodicAccessRate;
2110	UINT16 MinimumRequestTurnaroundTime;	2126	UINT16 MinimumRequestTurnaroundTime;
2111	EFI_ACPI_6_0_GENERIC_ADDRESS_STRUCTURE DoorbellAckRegister;	2127	EFI_ACPI_6_0_GENERIC_ADDRESS_STRUCTURE DoorbellAckRegister;
2112	UINT64 DoorbellAckPreserve;	2128	UINT64 DoorbellAckPreserve;
2113	UINT64 DoorbellAckWrite;	2129	UINT64 DoorbellAckWrite;
2114	} EFI_ACPI_6_0_PCCT_SUBSPACE_2_HW_REDUCED_COMMUNICATIONS;	2130	} EFI_ACPI_6_0_PCCT_SUBSPACE_2_HW_REDUCED_COMMUNICATIONS;
2115		2131
2116	//	2132	//




  This file contains AML code definition in the latest ACPI spec.

  Copyright (c) 2011, Intel Corporation. All rights reserved.<BR>
  Copyright (c) 2019 - 2021, Arm Limited. All rights reserved.<BR>
  SPDX-License-Identifier: BSD-2-Clause-Patent

**/

//
// Primary OpCode
//
#define AML_ZERO_OP                0x00
#define AML_ONE_OP                 0x01
#define AML_ALIAS_OP               0x06
#define AML_NAME_OP                0x08
#define AML_BYTE_PREFIX            0x0a
#define AML_WORD_PREFIX            0x0b
#define AML_DWORD_PREFIX           0x0c
#define AML_STRING_PREFIX          0x0d
#define AML_QWORD_PREFIX           0x0e
#define AML_SCOPE_OP               0x10
#define AML_BUFFER_OP              0x11
#define AML_PACKAGE_OP             0x12
#define AML_VAR_PACKAGE_OP         0x13
#define AML_METHOD_OP              0x14
#define AML_EXTERNAL_OP            0x15
#define AML_DUAL_NAME_PREFIX       0x2e
#define AML_MULTI_NAME_PREFIX      0x2f
#define AML_NAME_CHAR_A            0x41
#define AML_NAME_CHAR_B            0x42
#define AML_NAME_CHAR_C            0x43
#define AML_NAME_CHAR_D            0x44
#define AML_NAME_CHAR_E            0x45
#define AML_NAME_CHAR_F            0x46
#define AML_NAME_CHAR_G            0x47
#define AML_NAME_CHAR_H            0x48
#define AML_NAME_CHAR_I            0x49
#define AML_NAME_CHAR_J            0x4a
#define AML_NAME_CHAR_K            0x4b
#define AML_NAME_CHAR_L            0x4c
#define AML_NAME_CHAR_M            0x4d
#define AML_NAME_CHAR_N            0x4e
#define AML_NAME_CHAR_O            0x4f
#define AML_NAME_CHAR_P            0x50
#define AML_NAME_CHAR_Q            0x51
#define AML_NAME_CHAR_R            0x52
#define AML_NAME_CHAR_S            0x53
#define AML_NAME_CHAR_T            0x54
#define AML_NAME_CHAR_U            0x55
#define AML_NAME_CHAR_V            0x56
#define AML_NAME_CHAR_W            0x57
#define AML_NAME_CHAR_X            0x58
#define AML_NAME_CHAR_Y            0x59
#define AML_NAME_CHAR_Z            0x5a
#define AML_ROOT_CHAR              0x5c
#define AML_PARENT_PREFIX_CHAR     0x5e
#define AML_NAME_CHAR__            0x5f
#define AML_LOCAL0                 0x60
#define AML_LOCAL1                 0x61
#define AML_LOCAL2                 0x62
#define AML_LOCAL3                 0x63
#define AML_LOCAL4                 0x64
#define AML_LOCAL5                 0x65
#define AML_LOCAL6                 0x66
#define AML_LOCAL7                 0x67
#define AML_ARG0                   0x68
#define AML_ARG1                   0x69
#define AML_ARG2                   0x6a
#define AML_ARG3                   0x6b
#define AML_ARG4                   0x6c
#define AML_ARG5                   0x6d
#define AML_ARG6                   0x6e
#define AML_STORE_OP               0x70
#define AML_REF_OF_OP              0x71
#define AML_ADD_OP                 0x72
#define AML_CONCAT_OP              0x73
#define AML_SUBTRACT_OP            0x74
#define AML_INCREMENT_OP           0x75
#define AML_DECREMENT_OP           0x76
#define AML_MULTIPLY_OP            0x77
#define AML_DIVIDE_OP              0x78
#define AML_SHIFT_LEFT_OP          0x79
#define AML_SHIFT_RIGHT_OP         0x7a
#define AML_AND_OP                 0x7b
#define AML_NAND_OP                0x7c
#define AML_OR_OP                  0x7d
#define AML_NOR_OP                 0x7e
#define AML_XOR_OP                 0x7f
#define AML_NOT_OP                 0x80
#define AML_FIND_SET_LEFT_BIT_OP   0x81
#define AML_FIND_SET_RIGHT_BIT_OP  0x82
#define AML_DEREF_OF_OP            0x83
#define AML_CONCAT_RES_OP          0x84
#define AML_MOD_OP                 0x85
#define AML_NOTIFY_OP              0x86
#define AML_SIZE_OF_OP             0x87
#define AML_INDEX_OP               0x88
#define AML_MATCH_OP               0x89
#define AML_CREATE_DWORD_FIELD_OP  0x8a
#define AML_CREATE_WORD_FIELD_OP   0x8b
#define AML_CREATE_BYTE_FIELD_OP   0x8c
#define AML_CREATE_BIT_FIELD_OP    0x8d
#define AML_OBJECT_TYPE_OP         0x8e
#define AML_CREATE_QWORD_FIELD_OP  0x8f
#define AML_LAND_OP                0x90
#define AML_LOR_OP                 0x91
#define AML_LNOT_OP                0x92
#define AML_LEQUAL_OP              0x93
#define AML_LGREATER_OP            0x94
#define AML_LLESS_OP               0x95
#define AML_TO_BUFFER_OP           0x96
#define AML_TO_DEC_STRING_OP       0x97
#define AML_TO_HEX_STRING_OP       0x98
#define AML_TO_INTEGER_OP          0x99
#define AML_TO_STRING_OP           0x9c
#define AML_COPY_OBJECT_OP         0x9d
#define AML_MID_OP                 0x9e
#define AML_CONTINUE_OP            0x9f
#define AML_IF_OP                  0xa0
#define AML_ELSE_OP                0xa1
#define AML_WHILE_OP               0xa2
#define AML_NOOP_OP                0xa3
#define AML_RETURN_OP              0xa4
#define AML_BREAK_OP               0xa5
#define AML_BREAK_POINT_OP         0xcc
#define AML_ONES_OP                0xff

//
// Extended OpCode
//
#define AML_EXT_OP  0x5b

#define AML_EXT_MUTEX_OP         0x01
#define AML_EXT_EVENT_OP         0x02
#define AML_EXT_COND_REF_OF_OP   0x12
#define AML_EXT_CREATE_FIELD_OP  0x13
#define AML_EXT_LOAD_TABLE_OP    0x1f
#define AML_EXT_LOAD_OP          0x20
#define AML_EXT_STALL_OP         0x21
#define AML_EXT_SLEEP_OP         0x22
#define AML_EXT_ACQUIRE_OP       0x23
#define AML_EXT_SIGNAL_OP        0x24
#define AML_EXT_WAIT_OP          0x25
#define AML_EXT_RESET_OP         0x26
#define AML_EXT_RELEASE_OP       0x27
#define AML_EXT_FROM_BCD_OP      0x28
#define AML_EXT_TO_BCD_OP        0x29
#define AML_EXT_UNLOAD_OP        0x2a
#define AML_EXT_REVISION_OP      0x30
#define AML_EXT_DEBUG_OP         0x31
#define AML_EXT_FATAL_OP         0x32
#define AML_EXT_TIMER_OP         0x33
#define AML_EXT_REGION_OP        0x80
#define AML_EXT_FIELD_OP         0x81
#define AML_EXT_DEVICE_OP        0x82
#define AML_EXT_PROCESSOR_OP     0x83
#define AML_EXT_POWER_RES_OP     0x84
#define AML_EXT_THERMAL_ZONE_OP  0x85
#define AML_EXT_INDEX_FIELD_OP   0x86
#define AML_EXT_BANK_FIELD_OP    0x87
#define AML_EXT_DATA_REGION_OP   0x88

//
// FieldElement OpCode
//
#define AML_FIELD_RESERVED_OP    0x00
#define AML_FIELD_ACCESS_OP      0x01
#define AML_FIELD_CONNECTION_OP  0x02
#define AML_FIELD_EXT_ACCESS_OP  0x03

//
// AML Name segment definitions
//
#define AML_NAME_SEG_SIZE  4

#endif




  ///
  /// 48bit Bluetooth device address.
  ///
  UINT8    Address[6];
} BLUETOOTH_ADDRESS;

///
/// BLUETOOTH_CLASS_OF_DEVICE. See Bluetooth specification for detail.
///
typedef struct {
  UINT8     FormatType        : 2;
  UINT8     MinorDeviceClass  : 6;
  UINT16    MajorDeviceClass  : 5;
  UINT16    MajorServiceClass : 11;
} BLUETOOTH_CLASS_OF_DEVICE;

///

  ///
  /// 48-bit Bluetooth device address
  ///
  UINT8    Address[6];
  ///
  /// 0x00 - Public Device Address
  /// 0x01 - Random Device Address
  ///
  UINT8    Type;
} BLUETOOTH_LE_ADDRESS;

#pragma pack()

#define BLUETOOTH_HCI_COMMAND_LOCAL_READABLE_NAME_MAX_SIZE  248

#define BLUETOOTH_HCI_LINK_KEY_SIZE  16

#endif




/** @file
  EFI image format for PE32, PE32+ and TE. Please note some data structures are
  different for PE32 and PE32+. EFI_IMAGE_NT_HEADERS32 is for PE32 and
  EFI_IMAGE_NT_HEADERS64 is for PE32+.

  This file is coded to the Visual Studio, Microsoft Portable Executable and
  Common Object File Format Specification, Revision 9.3 - December 29, 2015.
  This file also includes some definitions in PI Specification, Revision 1.0.

Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>
Portions Copyright (c) 2016 - 2020, Hewlett Packard Enterprise Development LP. All rights reserved.<BR>
Portions Copyright (c) 2022, Loongson Technology Corporation Limited. All rights reserved.<BR>

SPDX-License-Identifier: BSD-2-Clause-Patent

**/

#ifndef __PE_IMAGE_H__
#define __PE_IMAGE_H__

//
// PE32+ Subsystem type for EFI images
//
#define EFI_IMAGE_SUBSYSTEM_EFI_APPLICATION          10
#define EFI_IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER  11
#define EFI_IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER       12
#define EFI_IMAGE_SUBSYSTEM_SAL_RUNTIME_DRIVER       13///< defined PI Specification, 1.0

//
// PE32+ Machine type for EFI images
//
#define IMAGE_FILE_MACHINE_I386            0x014c
#define IMAGE_FILE_MACHINE_IA64            0x0200
#define IMAGE_FILE_MACHINE_EBC             0x0EBC
#define IMAGE_FILE_MACHINE_X64             0x8664
#define IMAGE_FILE_MACHINE_ARMTHUMB_MIXED  0x01c2
#define IMAGE_FILE_MACHINE_ARM64           0xAA64
#define IMAGE_FILE_MACHINE_RISCV32         0x5032
#define IMAGE_FILE_MACHINE_RISCV64         0x5064
#define IMAGE_FILE_MACHINE_RISCV128        0x5128
#define IMAGE_FILE_MACHINE_LOONGARCH32     0x6232
#define IMAGE_FILE_MACHINE_LOONGARCH64     0x6264

//
// EXE file formats
//
#define EFI_IMAGE_DOS_SIGNATURE     SIGNATURE_16('M', 'Z')
#define EFI_IMAGE_OS2_SIGNATURE     SIGNATURE_16('N', 'E')
#define EFI_IMAGE_OS2_SIGNATURE_LE  SIGNATURE_16('L', 'E')
#define EFI_IMAGE_NT_SIGNATURE      SIGNATURE_32('P', 'E', '\0', '\0')

///
/// PE images can start with an optional DOS header, so if an image is run
/// under DOS it can print an error message.
///
typedef struct {
  UINT16    e_magic;    ///< Magic number.
  UINT16    e_cblp;     ///< Bytes on last page of file.
  UINT16    e_cp;       ///< Pages in file.
  UINT16    e_crlc;     ///< Relocations.
  UINT16    e_cparhdr;  ///< Size of header in paragraphs.
  UINT16    e_minalloc; ///< Minimum extra paragraphs needed.
  UINT16    e_maxalloc; ///< Maximum extra paragraphs needed.
  UINT16    e_ss;       ///< Initial (relative) SS value.
  UINT16    e_sp;       ///< Initial SP value.
  UINT16    e_csum;     ///< Checksum.
  UINT16    e_ip;       ///< Initial IP value.
  UINT16    e_cs;       ///< Initial (relative) CS value.
  UINT16    e_lfarlc;   ///< File address of relocation table.
  UINT16    e_ovno;     ///< Overlay number.
  UINT16    e_res[4];   ///< Reserved words.
  UINT16    e_oemid;    ///< OEM identifier (for e_oeminfo).
  UINT16    e_oeminfo;  ///< OEM information; e_oemid specific.
  UINT16    e_res2[10]; ///< Reserved words.
  UINT32    e_lfanew;   ///< File address of new exe header.
} EFI_IMAGE_DOS_HEADER;

///
/// COFF File Header (Object and Image).
///
typedef struct {
  UINT16    Machine;
  UINT16    NumberOfSections;
  UINT32    TimeDateStamp;
  UINT32    PointerToSymbolTable;
  UINT32    NumberOfSymbols;
  UINT16    SizeOfOptionalHeader;
  UINT16    Characteristics;
} EFI_IMAGE_FILE_HEADER;

///
/// Size of EFI_IMAGE_FILE_HEADER.
///
#define EFI_IMAGE_SIZEOF_FILE_HEADER  20

//
// Characteristics
//
#define EFI_IMAGE_FILE_RELOCS_STRIPPED      BIT0     ///< 0x0001  Relocation info stripped from file.
#define EFI_IMAGE_FILE_EXECUTABLE_IMAGE     BIT1     ///< 0x0002  File is executable  (i.e. no unresolved externel references).
#define EFI_IMAGE_FILE_LINE_NUMS_STRIPPED   BIT2     ///< 0x0004  Line numbers stripped from file.
#define EFI_IMAGE_FILE_LOCAL_SYMS_STRIPPED  BIT3     ///< 0x0008  Local symbols stripped from file.
#define EFI_IMAGE_FILE_LARGE_ADDRESS_AWARE  BIT5     ///< 0x0020  Supports addresses > 2-GB
#define EFI_IMAGE_FILE_BYTES_REVERSED_LO    BIT7     ///< 0x0080  Bytes of machine word are reversed.
#define EFI_IMAGE_FILE_32BIT_MACHINE        BIT8     ///< 0x0100  32 bit word machine.
#define EFI_IMAGE_FILE_DEBUG_STRIPPED       BIT9     ///< 0x0200  Debugging info stripped from file in .DBG file.
#define EFI_IMAGE_FILE_SYSTEM               BIT12    ///< 0x1000  System File.
#define EFI_IMAGE_FILE_DLL                  BIT13    ///< 0x2000  File is a DLL.
#define EFI_IMAGE_FILE_BYTES_REVERSED_HI    BIT15    ///< 0x8000  Bytes of machine word are reversed.

///
/// Header Data Directories.
///
typedef struct {
  UINT32    VirtualAddress;
  UINT32    Size;
} EFI_IMAGE_DATA_DIRECTORY;

//
// Directory Entries
//
#define EFI_IMAGE_DIRECTORY_ENTRY_EXPORT       0
#define EFI_IMAGE_DIRECTORY_ENTRY_IMPORT       1
#define EFI_IMAGE_DIRECTORY_ENTRY_RESOURCE     2
#define EFI_IMAGE_DIRECTORY_ENTRY_EXCEPTION    3
#define EFI_IMAGE_DIRECTORY_ENTRY_SECURITY     4
#define EFI_IMAGE_DIRECTORY_ENTRY_BASERELOC    5
#define EFI_IMAGE_DIRECTORY_ENTRY_DEBUG        6
#define EFI_IMAGE_DIRECTORY_ENTRY_COPYRIGHT    7
#define EFI_IMAGE_DIRECTORY_ENTRY_GLOBALPTR    8
#define EFI_IMAGE_DIRECTORY_ENTRY_TLS          9
#define EFI_IMAGE_DIRECTORY_ENTRY_LOAD_CONFIG  10

#define EFI_IMAGE_NUMBER_OF_DIRECTORY_ENTRIES  16

///
/// @attention
/// EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC means PE32 and
/// EFI_IMAGE_OPTIONAL_HEADER32 must be used. The data structures only vary
/// after NT additional fields.
///
#define EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC  0x10b

///
/// Optional Header Standard Fields for PE32.
///
typedef struct {
  ///
  /// Standard fields.
  ///
  UINT16                      Magic;
  UINT8                       MajorLinkerVersion;
  UINT8                       MinorLinkerVersion;
  UINT32                      SizeOfCode;
  UINT32                      SizeOfInitializedData;
  UINT32                      SizeOfUninitializedData;
  UINT32                      AddressOfEntryPoint;
  UINT32                      BaseOfCode;
  UINT32                      BaseOfData; ///< PE32 contains this additional field, which is absent in PE32+.
  ///
  /// Optional Header Windows-Specific Fields.
  ///
  UINT32                      ImageBase;
  UINT32                      SectionAlignment;
  UINT32                      FileAlignment;
  UINT16                      MajorOperatingSystemVersion;
  UINT16                      MinorOperatingSystemVersion;
  UINT16                      MajorImageVersion;
  UINT16                      MinorImageVersion;
  UINT16                      MajorSubsystemVersion;
  UINT16                      MinorSubsystemVersion;
  UINT32                      Win32VersionValue;
  UINT32                      SizeOfImage;
  UINT32                      SizeOfHeaders;
  UINT32                      CheckSum;
  UINT16                      Subsystem;
  UINT16                      DllCharacteristics;
  UINT32                      SizeOfStackReserve;
  UINT32                      SizeOfStackCommit;
  UINT32                      SizeOfHeapReserve;
  UINT32                      SizeOfHeapCommit;
  UINT32                      LoaderFlags;
  UINT32                      NumberOfRvaAndSizes;
  EFI_IMAGE_DATA_DIRECTORY    DataDirectory[EFI_IMAGE_NUMBER_OF_DIRECTORY_ENTRIES];
} EFI_IMAGE_OPTIONAL_HEADER32;

///
/// @attention
/// EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC means PE32+ and
/// EFI_IMAGE_OPTIONAL_HEADER64 must be used. The data structures only vary
/// after NT additional fields.
///
#define EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC  0x20b

///
/// Optional Header Standard Fields for PE32+.
///
typedef struct {
  ///
  /// Standard fields.
  ///
  UINT16                      Magic;
  UINT8                       MajorLinkerVersion;
  UINT8                       MinorLinkerVersion;
  UINT32                      SizeOfCode;
  UINT32                      SizeOfInitializedData;
  UINT32                      SizeOfUninitializedData;
  UINT32                      AddressOfEntryPoint;
  UINT32                      BaseOfCode;
  ///
  /// Optional Header Windows-Specific Fields.
  ///
  UINT64                      ImageBase;
  UINT32                      SectionAlignment;
  UINT32                      FileAlignment;
  UINT16                      MajorOperatingSystemVersion;
  UINT16                      MinorOperatingSystemVersion;
  UINT16                      MajorImageVersion;
  UINT16                      MinorImageVersion;
  UINT16                      MajorSubsystemVersion;
  UINT16                      MinorSubsystemVersion;
  UINT32                      Win32VersionValue;
  UINT32                      SizeOfImage;
  UINT32                      SizeOfHeaders;
  UINT32                      CheckSum;
  UINT16                      Subsystem;
  UINT16                      DllCharacteristics;
  UINT64                      SizeOfStackReserve;
  UINT64                      SizeOfStackCommit;
  UINT64                      SizeOfHeapReserve;
  UINT64                      SizeOfHeapCommit;
  UINT32                      LoaderFlags;
  UINT32                      NumberOfRvaAndSizes;
  EFI_IMAGE_DATA_DIRECTORY    DataDirectory[EFI_IMAGE_NUMBER_OF_DIRECTORY_ENTRIES];
} EFI_IMAGE_OPTIONAL_HEADER64;

///
/// @attention
/// EFI_IMAGE_NT_HEADERS32 is for use ONLY by tools.
///
typedef struct {
  UINT32                         Signature;
  EFI_IMAGE_FILE_HEADER          FileHeader;
  EFI_IMAGE_OPTIONAL_HEADER32    OptionalHeader;
} EFI_IMAGE_NT_HEADERS32;

#define EFI_IMAGE_SIZEOF_NT_OPTIONAL32_HEADER  sizeof (EFI_IMAGE_NT_HEADERS32)

///
/// @attention
/// EFI_IMAGE_HEADERS64 is for use ONLY by tools.
///
typedef struct {
  UINT32                         Signature;
  EFI_IMAGE_FILE_HEADER          FileHeader;
  EFI_IMAGE_OPTIONAL_HEADER64    OptionalHeader;
} EFI_IMAGE_NT_HEADERS64;

#define EFI_IMAGE_SIZEOF_NT_OPTIONAL64_HEADER  sizeof (EFI_IMAGE_NT_HEADERS64)

//
// Other Windows Subsystem Values
//
#define EFI_IMAGE_SUBSYSTEM_UNKNOWN      0
#define EFI_IMAGE_SUBSYSTEM_NATIVE       1
#define EFI_IMAGE_SUBSYSTEM_WINDOWS_GUI  2
#define EFI_IMAGE_SUBSYSTEM_WINDOWS_CUI  3
#define EFI_IMAGE_SUBSYSTEM_OS2_CUI      5
#define EFI_IMAGE_SUBSYSTEM_POSIX_CUI    7

//
// DLL Characteristics
//
#define IMAGE_DLLCHARACTERISTICS_HIGH_ENTROPY_VA        0x0020
#define IMAGE_DLLCHARACTERISTICS_DYNAMIC_BASE           0x0040
#define IMAGE_DLLCHARACTERISTICS_FORCE_INTEGRITY        0x0080
#define IMAGE_DLLCHARACTERISTICS_NX_COMPAT              0x0100
#define IMAGE_DLLCHARACTERISTICS_NO_ISOLATION           0x0200
#define IMAGE_DLLCHARACTERISTICS_NO_SEH                 0x0400
#define IMAGE_DLLCHARACTERISTICS_NO_BIND                0x0800
#define IMAGE_DLLCHARACTERISTICS_APPCONTAINER           0x1000
#define IMAGE_DLLCHARACTERISTICS_WDM_DRIVER             0x2000
#define IMAGE_DLLCHARACTERISTICS_GUARD_CF               0x4000
#define IMAGE_DLLCHARACTERISTICS_TERMINAL_SERVER_AWARE  0x8000

///
/// Length of ShortName.
///
#define EFI_IMAGE_SIZEOF_SHORT_NAME  8

///
/// Section Table. This table immediately follows the optional header.
///
typedef struct {
  UINT8     Name[EFI_IMAGE_SIZEOF_SHORT_NAME];
  union {
    UINT32    PhysicalAddress;
    UINT32    VirtualSize;
  } Misc;
  UINT32    VirtualAddress;
  UINT32    SizeOfRawData;
  UINT32    PointerToRawData;
  UINT32    PointerToRelocations;
  UINT32    PointerToLinenumbers;
  UINT16    NumberOfRelocations;
  UINT16    NumberOfLinenumbers;
  UINT32    Characteristics;
} EFI_IMAGE_SECTION_HEADER;

///
/// Size of EFI_IMAGE_SECTION_HEADER.
///
#define EFI_IMAGE_SIZEOF_SECTION_HEADER  40

//
// Section Flags Values
//
#define EFI_IMAGE_SCN_TYPE_NO_PAD             BIT3        ///< 0x00000008  ///< Reserved.
#define EFI_IMAGE_SCN_CNT_CODE                BIT5        ///< 0x00000020
#define EFI_IMAGE_SCN_CNT_INITIALIZED_DATA    BIT6        ///< 0x00000040
#define EFI_IMAGE_SCN_CNT_UNINITIALIZED_DATA  BIT7        ///< 0x00000080

#define EFI_IMAGE_SCN_LNK_OTHER   BIT8                    ///< 0x00000100  ///< Reserved.
#define EFI_IMAGE_SCN_LNK_INFO    BIT9                    ///< 0x00000200  ///< Section contains comments or some other type of information.
#define EFI_IMAGE_SCN_LNK_REMOVE  BIT11                   ///< 0x00000800  ///< Section contents will not become part of image.
#define EFI_IMAGE_SCN_LNK_COMDAT  BIT12                   ///< 0x00001000

#define EFI_IMAGE_SCN_ALIGN_1BYTES   BIT20                ///< 0x00100000
#define EFI_IMAGE_SCN_ALIGN_2BYTES   BIT21                ///< 0x00200000
#define EFI_IMAGE_SCN_ALIGN_4BYTES   (BIT20|BIT21)        ///< 0x00300000
#define EFI_IMAGE_SCN_ALIGN_8BYTES   BIT22                ///< 0x00400000
#define EFI_IMAGE_SCN_ALIGN_16BYTES  (BIT20|BIT22)        ///< 0x00500000
#define EFI_IMAGE_SCN_ALIGN_32BYTES  (BIT21|BIT22)        ///< 0x00600000
#define EFI_IMAGE_SCN_ALIGN_64BYTES  (BIT20|BIT21|BIT22)  ///< 0x00700000

#define EFI_IMAGE_SCN_MEM_DISCARDABLE  BIT25              ///< 0x02000000
#define EFI_IMAGE_SCN_MEM_NOT_CACHED   BIT26              ///< 0x04000000
#define EFI_IMAGE_SCN_MEM_NOT_PAGED    BIT27              ///< 0x08000000
#define EFI_IMAGE_SCN_MEM_SHARED       BIT28              ///< 0x10000000
#define EFI_IMAGE_SCN_MEM_EXECUTE      BIT29              ///< 0x20000000
#define EFI_IMAGE_SCN_MEM_READ         BIT30              ///< 0x40000000
#define EFI_IMAGE_SCN_MEM_WRITE        BIT31              ///< 0x80000000

///
/// Size of a Symbol Table Record.
///
#define EFI_IMAGE_SIZEOF_SYMBOL  18

//
// Symbols have a section number of the section in which they are
// defined. Otherwise, section numbers have the following meanings:
//
#define EFI_IMAGE_SYM_UNDEFINED  (UINT16) 0  ///< Symbol is undefined or is common.
#define EFI_IMAGE_SYM_ABSOLUTE   (UINT16) -1 ///< Symbol is an absolute value.
#define EFI_IMAGE_SYM_DEBUG      (UINT16) -2 ///< Symbol is a special debug item.

//
// Symbol Type (fundamental) values.
//
#define EFI_IMAGE_SYM_TYPE_NULL    0  ///< no type.
#define EFI_IMAGE_SYM_TYPE_VOID    1  ///< no valid type.
#define EFI_IMAGE_SYM_TYPE_CHAR    2  ///< type character.
#define EFI_IMAGE_SYM_TYPE_SHORT   3  ///< type short integer.
#define EFI_IMAGE_SYM_TYPE_INT     4
#define EFI_IMAGE_SYM_TYPE_LONG    5
#define EFI_IMAGE_SYM_TYPE_FLOAT   6
#define EFI_IMAGE_SYM_TYPE_DOUBLE  7
#define EFI_IMAGE_SYM_TYPE_STRUCT  8
#define EFI_IMAGE_SYM_TYPE_UNION   9
#define EFI_IMAGE_SYM_TYPE_ENUM    10 ///< enumeration.
#define EFI_IMAGE_SYM_TYPE_MOE     11 ///< member of enumeration.
#define EFI_IMAGE_SYM_TYPE_BYTE    12
#define EFI_IMAGE_SYM_TYPE_WORD    13
#define EFI_IMAGE_SYM_TYPE_UINT    14
#define EFI_IMAGE_SYM_TYPE_DWORD   15

//
// Symbol Type (derived) values.
//
#define EFI_IMAGE_SYM_DTYPE_NULL      0 ///< no derived type.
#define EFI_IMAGE_SYM_DTYPE_POINTER   1
#define EFI_IMAGE_SYM_DTYPE_FUNCTION  2
#define EFI_IMAGE_SYM_DTYPE_ARRAY     3

//
// Storage classes.
//
#define EFI_IMAGE_SYM_CLASS_END_OF_FUNCTION   ((UINT8) -1)
#define EFI_IMAGE_SYM_CLASS_NULL              0
#define EFI_IMAGE_SYM_CLASS_AUTOMATIC         1
#define EFI_IMAGE_SYM_CLASS_EXTERNAL          2
#define EFI_IMAGE_SYM_CLASS_STATIC            3
#define EFI_IMAGE_SYM_CLASS_REGISTER          4
#define EFI_IMAGE_SYM_CLASS_EXTERNAL_DEF      5
#define EFI_IMAGE_SYM_CLASS_LABEL             6
#define EFI_IMAGE_SYM_CLASS_UNDEFINED_LABEL   7
#define EFI_IMAGE_SYM_CLASS_MEMBER_OF_STRUCT  8
#define EFI_IMAGE_SYM_CLASS_ARGUMENT          9
#define EFI_IMAGE_SYM_CLASS_STRUCT_TAG        10
#define EFI_IMAGE_SYM_CLASS_MEMBER_OF_UNION   11
#define EFI_IMAGE_SYM_CLASS_UNION_TAG         12
#define EFI_IMAGE_SYM_CLASS_TYPE_DEFINITION   13
#define EFI_IMAGE_SYM_CLASS_UNDEFINED_STATIC  14
#define EFI_IMAGE_SYM_CLASS_ENUM_TAG          15
#define EFI_IMAGE_SYM_CLASS_MEMBER_OF_ENUM    16
#define EFI_IMAGE_SYM_CLASS_REGISTER_PARAM    17
#define EFI_IMAGE_SYM_CLASS_BIT_FIELD         18
#define EFI_IMAGE_SYM_CLASS_BLOCK             100
#define EFI_IMAGE_SYM_CLASS_FUNCTION          101
#define EFI_IMAGE_SYM_CLASS_END_OF_STRUCT     102
#define EFI_IMAGE_SYM_CLASS_FILE              103
#define EFI_IMAGE_SYM_CLASS_SECTION           104
#define EFI_IMAGE_SYM_CLASS_WEAK_EXTERNAL     105

//
// type packing constants
//
#define EFI_IMAGE_N_BTMASK  017
#define EFI_IMAGE_N_TMASK   060
#define EFI_IMAGE_N_TMASK1  0300
#define EFI_IMAGE_N_TMASK2  0360
#define EFI_IMAGE_N_BTSHFT  4
#define EFI_IMAGE_N_TSHIFT  2

//
// Communal selection types.
//
#define EFI_IMAGE_COMDAT_SELECT_NODUPLICATES  1
#define EFI_IMAGE_COMDAT_SELECT_ANY           2
#define EFI_IMAGE_COMDAT_SELECT_SAME_SIZE     3
#define EFI_IMAGE_COMDAT_SELECT_EXACT_MATCH   4
#define EFI_IMAGE_COMDAT_SELECT_ASSOCIATIVE   5

//
// the following values only be referred in PeCoff, not defined in PECOFF.
//
#define EFI_IMAGE_WEAK_EXTERN_SEARCH_NOLIBRARY  1
#define EFI_IMAGE_WEAK_EXTERN_SEARCH_LIBRARY    2
#define EFI_IMAGE_WEAK_EXTERN_SEARCH_ALIAS      3

///
/// Relocation format.
///
typedef struct {
  UINT32    VirtualAddress;
  UINT32    SymbolTableIndex;
  UINT16    Type;
} EFI_IMAGE_RELOCATION;

///
/// Size of EFI_IMAGE_RELOCATION
///
#define EFI_IMAGE_SIZEOF_RELOCATION  10

//
// I386 relocation types.
//
#define EFI_IMAGE_REL_I386_ABSOLUTE  0x0000 ///< Reference is absolute, no relocation is necessary.
#define EFI_IMAGE_REL_I386_DIR16     0x0001 ///< Direct 16-bit reference to the symbols virtual address.
#define EFI_IMAGE_REL_I386_REL16     0x0002 ///< PC-relative 16-bit reference to the symbols virtual address.
#define EFI_IMAGE_REL_I386_DIR32     0x0006 ///< Direct 32-bit reference to the symbols virtual address.
#define EFI_IMAGE_REL_I386_DIR32NB   0x0007 ///< Direct 32-bit reference to the symbols virtual address, base not included.
#define EFI_IMAGE_REL_I386_SEG12     0x0009 ///< Direct 16-bit reference to the segment-selector bits of a 32-bit virtual address.
#define EFI_IMAGE_REL_I386_SECTION   0x000A
#define EFI_IMAGE_REL_I386_SECREL    0x000B
#define EFI_IMAGE_REL_I386_REL32     0x0014 ///< PC-relative 32-bit reference to the symbols virtual address.

//
// x64 processor relocation types.
//
#define IMAGE_REL_AMD64_ABSOLUTE  0x0000
#define IMAGE_REL_AMD64_ADDR64    0x0001
#define IMAGE_REL_AMD64_ADDR32    0x0002
#define IMAGE_REL_AMD64_ADDR32NB  0x0003
#define IMAGE_REL_AMD64_REL32     0x0004
#define IMAGE_REL_AMD64_REL32_1   0x0005
#define IMAGE_REL_AMD64_REL32_2   0x0006
#define IMAGE_REL_AMD64_REL32_3   0x0007
#define IMAGE_REL_AMD64_REL32_4   0x0008
#define IMAGE_REL_AMD64_REL32_5   0x0009
#define IMAGE_REL_AMD64_SECTION   0x000A
#define IMAGE_REL_AMD64_SECREL    0x000B
#define IMAGE_REL_AMD64_SECREL7   0x000C
#define IMAGE_REL_AMD64_TOKEN     0x000D
#define IMAGE_REL_AMD64_SREL32    0x000E
#define IMAGE_REL_AMD64_PAIR      0x000F
#define IMAGE_REL_AMD64_SSPAN32   0x0010

///
/// Based relocation format.
///
typedef struct {
  UINT32    VirtualAddress;
  UINT32    SizeOfBlock;
} EFI_IMAGE_BASE_RELOCATION;

///
/// Size of EFI_IMAGE_BASE_RELOCATION.
///
#define EFI_IMAGE_SIZEOF_BASE_RELOCATION  8

//
// Based relocation types.
//
#define EFI_IMAGE_REL_BASED_ABSOLUTE        0
#define EFI_IMAGE_REL_BASED_HIGH            1
#define EFI_IMAGE_REL_BASED_LOW             2
#define EFI_IMAGE_REL_BASED_HIGHLOW         3
#define EFI_IMAGE_REL_BASED_HIGHADJ         4
#define EFI_IMAGE_REL_BASED_MIPS_JMPADDR    5
#define EFI_IMAGE_REL_BASED_ARM_MOV32A      5
#define EFI_IMAGE_REL_BASED_ARM_MOV32T      7
#define EFI_IMAGE_REL_BASED_IA64_IMM64      9
#define EFI_IMAGE_REL_BASED_MIPS_JMPADDR16  9
#define EFI_IMAGE_REL_BASED_DIR64           10

///
/// Relocation types of RISC-V processor.
///
#define EFI_IMAGE_REL_BASED_RISCV_HI20    5
#define EFI_IMAGE_REL_BASED_RISCV_LOW12I  7
#define EFI_IMAGE_REL_BASED_RISCV_LOW12S  8

//
// Relocation types of LoongArch processor.
//
#define EFI_IMAGE_REL_BASED_LOONGARCH32_MARK_LA  8
#define EFI_IMAGE_REL_BASED_LOONGARCH64_MARK_LA  8

///
/// Line number format.
///
typedef struct {
  union {
    UINT32    SymbolTableIndex; ///< Symbol table index of function name if Linenumber is 0.
    UINT32    VirtualAddress;   ///< Virtual address of line number.
  } Type;
  UINT16    Linenumber;       ///< Line number.
} EFI_IMAGE_LINENUMBER;

///
/// Size of EFI_IMAGE_LINENUMBER.
///
#define EFI_IMAGE_SIZEOF_LINENUMBER  6

//
// Archive format.
//
#define EFI_IMAGE_ARCHIVE_START_SIZE        8
#define EFI_IMAGE_ARCHIVE_START             "!<arch>\n"
#define EFI_IMAGE_ARCHIVE_END               "`\n"
#define EFI_IMAGE_ARCHIVE_PAD               "\n"
#define EFI_IMAGE_ARCHIVE_LINKER_MEMBER     "/               "
#define EFI_IMAGE_ARCHIVE_LONGNAMES_MEMBER  "//              "

///
/// Archive Member Headers
///
typedef struct {
  UINT8    Name[16];     ///< File member name - `/' terminated.
  UINT8    Date[12];     ///< File member date - decimal.
  UINT8    UserID[6];    ///< File member user id - decimal.
  UINT8    GroupID[6];   ///< File member group id - decimal.
  UINT8    Mode[8];      ///< File member mode - octal.
  UINT8    Size[10];     ///< File member size - decimal.
  UINT8    EndHeader[2]; ///< String to end header. (0x60 0x0A).
} EFI_IMAGE_ARCHIVE_MEMBER_HEADER;

///
/// Size of EFI_IMAGE_ARCHIVE_MEMBER_HEADER.
///
#define EFI_IMAGE_SIZEOF_ARCHIVE_MEMBER_HDR  60

//
// DLL Support
//

///
/// Export Directory Table.
///
typedef struct {
  UINT32    Characteristics;
  UINT32    TimeDateStamp;
  UINT16    MajorVersion;
  UINT16    MinorVersion;
  UINT32    Name;
  UINT32    Base;
  UINT32    NumberOfFunctions;
  UINT32    NumberOfNames;
  UINT32    AddressOfFunctions;
  UINT32    AddressOfNames;
  UINT32    AddressOfNameOrdinals;
} EFI_IMAGE_EXPORT_DIRECTORY;

//
// Based export types.
//
#define EFI_IMAGE_EXPORT_ORDINAL_BASE  1
#define EFI_IMAGE_EXPORT_ADDR_SIZE     4
#define EFI_IMAGE_EXPORT_ORDINAL_SIZE  2

///
/// Hint/Name Table.
///
typedef struct {
  UINT16    Hint;
  UINT8     Name[1];
} EFI_IMAGE_IMPORT_BY_NAME;

///
/// Import Address Table RVA (Thunk Table).
///
typedef struct {
  union {
    UINT32                      Function;
    UINT32                      Ordinal;
    EFI_IMAGE_IMPORT_BY_NAME    *AddressOfData;
  } u1;
} EFI_IMAGE_THUNK_DATA;

#define EFI_IMAGE_ORDINAL_FLAG  BIT31                ///< Flag for PE32.
#define EFI_IMAGE_SNAP_BY_ORDINAL(Ordinal)  ((Ordinal & EFI_IMAGE_ORDINAL_FLAG) != 0)
#define EFI_IMAGE_ORDINAL(Ordinal)          (Ordinal & 0xffff)

///
/// Import Directory Table
///
typedef struct {
  UINT32                  Characteristics;
  UINT32                  TimeDateStamp;
  UINT32                  ForwarderChain;
  UINT32                  Name;
  EFI_IMAGE_THUNK_DATA    *FirstThunk;
} EFI_IMAGE_IMPORT_DESCRIPTOR;

///
/// Debug Directory Format.
///
typedef struct {
  UINT32    Characteristics;
  UINT32    TimeDateStamp;
  UINT16    MajorVersion;
  UINT16    MinorVersion;
  UINT32    Type;
  UINT32    SizeOfData;
  UINT32    RVA;         ///< The address of the debug data when loaded, relative to the image base.
  UINT32    FileOffset;  ///< The file pointer to the debug data.
} EFI_IMAGE_DEBUG_DIRECTORY_ENTRY;

#define EFI_IMAGE_DEBUG_TYPE_CODEVIEW               2    ///< The Visual C++ debug information.
#define EFI_IMAGE_DEBUG_TYPE_EX_DLLCHARACTERISTICS  20

///
/// Debug Data Structure defined in Microsoft C++.
///
#define CODEVIEW_SIGNATURE_NB10  SIGNATURE_32('N', 'B', '1', '0')
typedef struct {
  UINT32    Signature;                      ///< "NB10"
  UINT32    Unknown;
  UINT32    Unknown2;
  UINT32    Unknown3;
  //
  // Filename of .PDB goes here
  //
} EFI_IMAGE_DEBUG_CODEVIEW_NB10_ENTRY;

///
/// Debug Data Structure defined in Microsoft C++.
///
#define CODEVIEW_SIGNATURE_RSDS  SIGNATURE_32('R', 'S', 'D', 'S')
typedef struct {
  UINT32    Signature;                      ///< "RSDS".
  UINT32    Unknown;
  UINT32    Unknown2;
  UINT32    Unknown3;
  UINT32    Unknown4;
  UINT32    Unknown5;
  //
  // Filename of .PDB goes here
  //
} EFI_IMAGE_DEBUG_CODEVIEW_RSDS_ENTRY;

///
/// Debug Data Structure defined by Apple Mach-O to Coff utility.
///
#define CODEVIEW_SIGNATURE_MTOC  SIGNATURE_32('M', 'T', 'O', 'C')
typedef struct {
  UINT32    Signature;                       ///< "MTOC".
  GUID      MachOUuid;
  //
  //  Filename of .DLL (Mach-O with debug info) goes here
  //
} EFI_IMAGE_DEBUG_CODEVIEW_MTOC_ENTRY;

//
// .pdata entries for X64
//
typedef struct {
  UINT32    FunctionStartAddress;
  UINT32    FunctionEndAddress;
  UINT32    UnwindInfoAddress;
} RUNTIME_FUNCTION;

typedef struct {
  UINT8    Version             : 3;
  UINT8    Flags               : 5;
  UINT8    SizeOfProlog;
  UINT8    CountOfUnwindCodes;
  UINT8    FrameRegister       : 4;
  UINT8    FrameRegisterOffset : 4;
} UNWIND_INFO;

///
/// Extended DLL Characteristics
///
#define EFI_IMAGE_DLLCHARACTERISTICS_EX_CET_COMPAT          0x0001
#define EFI_IMAGE_DLLCHARACTERISTICS_EX_FORWARD_CFI_COMPAT  0x0040

typedef struct {
  UINT32    DllCharacteristicsEx;
} EFI_IMAGE_DEBUG_EX_DLLCHARACTERISTICS_ENTRY;

///
/// Resource format.
///
typedef struct {
  UINT32    Characteristics;
  UINT32    TimeDateStamp;
  UINT16    MajorVersion;
  UINT16    MinorVersion;
  UINT16    NumberOfNamedEntries;
  UINT16    NumberOfIdEntries;
  //
  // Array of EFI_IMAGE_RESOURCE_DIRECTORY_ENTRY entries goes here.
  //
} EFI_IMAGE_RESOURCE_DIRECTORY;

///
/// Resource directory entry format.
///
typedef struct {
  union {
    struct {
      UINT32    NameOffset   : 31;
      UINT32    NameIsString : 1;
    } s;
    UINT32    Id;
  } u1;
  union {
    UINT32    OffsetToData;
    struct {
      UINT32    OffsetToDirectory : 31;
      UINT32    DataIsDirectory   : 1;
    } s;
  } u2;
} EFI_IMAGE_RESOURCE_DIRECTORY_ENTRY;

///
/// Resource directory entry for string.
///
typedef struct {
  UINT16    Length;
  CHAR16    String[1];
} EFI_IMAGE_RESOURCE_DIRECTORY_STRING;

///
/// Resource directory entry for data array.
///
typedef struct {
  UINT32    OffsetToData;
  UINT32    Size;
  UINT32    CodePage;
  UINT32    Reserved;
} EFI_IMAGE_RESOURCE_DATA_ENTRY;

///
/// Header format for TE images, defined in the PI Specification, 1.0.
///
typedef struct {
  UINT16                      Signature;           ///< The signature for TE format = "VZ".
  UINT16                      Machine;             ///< From the original file header.
  UINT8                       NumberOfSections;    ///< From the original file header.
  UINT8                       Subsystem;           ///< From original optional header.
  UINT16                      StrippedSize;        ///< Number of bytes we removed from the header.
  UINT32                      AddressOfEntryPoint; ///< Offset to entry point -- from original optional header.
  UINT32                      BaseOfCode;          ///< From original image -- required for ITP debug.
  UINT64                      ImageBase;           ///< From original file header.
  EFI_IMAGE_DATA_DIRECTORY    DataDirectory[2];    ///< Only base relocation and debug directory.
} EFI_TE_IMAGE_HEADER;

#define EFI_TE_IMAGE_HEADER_SIGNATURE  SIGNATURE_16('V', 'Z')

//
// Data directory indexes in our TE image header
//
#define EFI_TE_IMAGE_DIRECTORY_ENTRY_BASERELOC  0
#define EFI_TE_IMAGE_DIRECTORY_ENTRY_DEBUG      1

///
/// Union of PE32, PE32+, and TE headers.
///
typedef union {
  EFI_IMAGE_NT_HEADERS32    Pe32;
  EFI_IMAGE_NT_HEADERS64    Pe32Plus;
  EFI_TE_IMAGE_HEADER       Te;
} EFI_IMAGE_OPTIONAL_HEADER_UNION;

typedef union {
  EFI_IMAGE_NT_HEADERS32             *Pe32;
  EFI_IMAGE_NT_HEADERS64             *Pe32Plus;
  EFI_TE_IMAGE_HEADER                *Te;
  EFI_IMAGE_OPTIONAL_HEADER_UNION    *Union;
} EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION;

#endif




  Provides string functions, linked list functions, math functions, synchronization
  functions, file path functions, and CPU architecture-specific functions.

Copyright (c) 2006 - 2021, Intel Corporation. All rights reserved.<BR>
Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>
Copyright (c) Microsoft Corporation.<BR>
Portions Copyright (c) 2020, Hewlett Packard Enterprise Development LP. All rights reserved.<BR>
Portions Copyright (c) 2022, Loongson Technology Corporation Limited. All rights reserved.<BR>

SPDX-License-Identifier: BSD-2-Clause-Patent


/// The IA-32 architecture context buffer used by SetJump() and LongJump().
///
typedef struct {
  UINT32    Ebx;
  UINT32    Esi;
  UINT32    Edi;
  UINT32    Ebp;
  UINT32    Esp;
  UINT32    Eip;
  UINT32    Ssp;
} BASE_LIBRARY_JUMP_BUFFER;

#define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT  4

#endif // defined (MDE_CPU_IA32)


/// The x64 architecture context buffer used by SetJump() and LongJump().
///
typedef struct {
  UINT64    Rbx;
  UINT64    Rsp;
  UINT64    Rbp;
  UINT64    Rdi;
  UINT64    Rsi;
  UINT64    R12;
  UINT64    R13;
  UINT64    R14;
  UINT64    R15;
  UINT64    Rip;
  UINT64    MxCsr;
  UINT8     XmmBuffer[160];                         ///< XMM6-XMM15.
  UINT64    Ssp;
} BASE_LIBRARY_JUMP_BUFFER;

#define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT  8

#endif // defined (MDE_CPU_X64)


/// The EBC context buffer used by SetJump() and LongJump().
///
typedef struct {
  UINT64    R0;
  UINT64    R1;
  UINT64    R2;
  UINT64    R3;
  UINT64    IP;
} BASE_LIBRARY_JUMP_BUFFER;

#define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT  8

#endif // defined (MDE_CPU_EBC)


  UINT32    R14;
} BASE_LIBRARY_JUMP_BUFFER;

#define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT  4

#endif // defined (MDE_CPU_ARM)

#if defined (MDE_CPU_AARCH64)
typedef struct {

  UINT64    D15;
} BASE_LIBRARY_JUMP_BUFFER;

#define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT  8

#endif // defined (MDE_CPU_AARCH64)

#if defined (MDE_CPU_RISCV64)
///
/// The RISC-V architecture context buffer used by SetJump() and LongJump().
///
typedef struct {
  UINT64    RA;
  UINT64    S0;
  UINT64    S1;
  UINT64    S2;
  UINT64    S3;
  UINT64    S4;
  UINT64    S5;
  UINT64    S6;
  UINT64    S7;
  UINT64    S8;
  UINT64    S9;
  UINT64    S10;
  UINT64    S11;
  UINT64    SP;
} BASE_LIBRARY_JUMP_BUFFER;

#define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT  8

VOID
RiscVSetSupervisorScratch (
  IN UINT64
  );

UINT64
RiscVGetSupervisorScratch (
  VOID
  );

VOID
RiscVSetSupervisorStvec (
  IN UINT64
  );

UINT64
RiscVGetSupervisorStvec (
  VOID
  );

UINT64
RiscVGetSupervisorTrapCause (
  VOID
  );

VOID
RiscVSetSupervisorAddressTranslationRegister (
  IN UINT64
  );

UINT64
RiscVGetSupervisorAddressTranslationRegister (
  VOID
  );

UINT64
RiscVReadTimer (
  VOID
  );

VOID
RiscVSetSupervisorTimeCompareRegister (
  IN UINT64
  );

VOID
RiscVEnableTimerInterrupt (
  VOID
  );

VOID
RiscVDisableTimerInterrupt (
  VOID
  );

VOID
RiscVClearPendingTimerInterrupt (
  VOID
  );

/**
  RISC-V invalidate instruction cache.

**/
VOID
EFIAPI
RiscVInvalidateInstCacheFenceAsm (
  VOID
  );

/**
  RISC-V invalidate data cache.

**/
VOID
EFIAPI
RiscVInvalidateDataCacheFenceAsm (
  VOID
  );

/**
  RISC-V flush cache block. Atomically perform a clean operation
  followed by an invalidate operation

**/
VOID
EFIAPI
RiscVCpuCacheFlushCmoAsm (
  IN UINTN
  );

/**
Perform a write transfer to another cache or to memory if the
data in the copy of the cache block have been modified by a store
operation

**/
VOID
EFIAPI
RiscVCpuCacheCleanCmoAsm (
  IN UINTN
  );

/**
Deallocate the copy of the cache block

**/
VOID
EFIAPI
RiscVCpuCacheInvalCmoAsm (
  IN UINTN
  );

#endif // defined (MDE_CPU_RISCV64)

#if defined (MDE_CPU_LOONGARCH64)
///
/// The LoongArch architecture context buffer used by SetJump() and LongJump()
///
typedef struct {
  UINT64    S0;
  UINT64    S1;
  UINT64    S2;
  UINT64    S3;
  UINT64    S4;
  UINT64    S5;
  UINT64    S6;
  UINT64    S7;
  UINT64    S8;
  UINT64    SP;
  UINT64    FP;
  UINT64    RA;
} BASE_LIBRARY_JUMP_BUFFER;

#define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT  8

/*
 * Set the exception base address for LoongArch.
 *
 * @param  ExceptionBaseAddress   The exception base address, must be aligned greater than or qeual to 4K .
 */
VOID
SetExceptionBaseAddress (
  IN UINT64
  );

/*
 * Set the TlbRebase address for LoongArch.
 *
 * @param  TlbRebaseAddress   The TlbRebase address, must be aligned greater than or qeual to 4K .
 */
VOID
SetTlbRebaseAddress (
  IN UINT64
  );

/**
  Enables local CPU interrupts.

  @param  Needs to enable local interrupt bit.
**/
VOID
EnableLocalInterrupts (
  IN UINT16
  );

/**
  Disables local CPU interrupts.

  @param  Needs to disable local interrupt bit.
**/
VOID
DisableLocalInterrupts (
  IN UINT16
  );

/**
  Read CPUCFG register.

  @param  Index  Specifies the register number of the CPUCFG to read the data.
  @param  Data   A pointer to the variable used to store the CPUCFG register value.
**/
VOID
AsmCpucfg (
  IN  UINT32  Index,
  OUT UINT32  *Data
  );

/**
  Gets the timer count value.

  @param[] VOID
  @retval  timer count value.

**/
UINTN
AsmReadStableCounter (
  VOID
  );

/**
  CSR read operation.

  @param[in]  Select   CSR read instruction select values.

  @return     The return value of csrrd instruction, return -1 means no CSR instruction
              is found.
**/
UINTN
CsrRead (
  IN UINT16  Select
  );

/**
  CSR write operation.

  @param[in]  Select   CSR write instruction select values.
  @param[in]  Value    The csrwr will write the value.

  @return     The return value of csrwr instruction, that is, store the old value of
              the register, return -1 means no CSR instruction is found.
**/
UINTN
CsrWrite (
  IN UINT16  Select,
  IN UINTN   Value
  );

/**
  CSR exchange operation.

  @param[in]  Select   CSR exchange instruction select values.
  @param[in]  Value    The csrxchg will write the value.
  @param[in]  Mask     The csrxchg mask value.

  @return     The return value of csrxchg instruction, that is, store the old value of
              the register, return -1 means no CSR instruction is found.
**/
UINTN
CsrXChg (
  IN UINT16  Select,
  IN UINTN   Value,
  IN UINTN   Mask
  );

/**
  IO CSR read byte operation.

  @param[in]  Select   IO CSR read instruction select values.

  @return     The return value of iocsrrd.b instruction.

**/
UINT8
IoCsrRead8 (
  IN UINTN  Select
  );

/**
  IO CSR read half word operation.

  @param[in]  Select   IO CSR read instruction select values.

  @return     The return value of iocsrrd.h instruction.

**/
UINT16
IoCsrRead16 (
  IN UINTN  Select
  );

/**
  IO CSR read word operation.

  @param[in]  Select   IO CSR read instruction select values.

  @return     The return value of iocsrrd.w instruction.

**/
UINT32
IoCsrRead32 (
  IN UINTN  Select
  );

/**
  IO CSR read double word operation. Only for LoongArch64.

  @param[in]  Select   IO CSR read instruction select values.

  @return     The return value of iocsrrd.d instruction.

**/
UINT64
IoCsrRead64 (
  IN UINTN  Select
  );

/**
  IO CSR write byte operation.

  @param[in]  Select   IO CSR write instruction select values.
  @param[in]  Value    The iocsrwr.b will write the value.

  @return     VOID.

**/
VOID
IoCsrWrite8 (
  IN UINTN  Select,
  IN UINT8  Value
  );

/**
  IO CSR write half word operation.

  @param[in]  Select   IO CSR write instruction select values.
  @param[in]  Value    The iocsrwr.h will write the value.

  @return     VOID.

**/
VOID
IoCsrWrite16 (
  IN UINTN   Select,
  IN UINT16  Value
  );

/**
  IO CSR write word operation.

  @param[in]  Select   IO CSR write instruction select values.
  @param[in]  Value    The iocsrwr.w will write the value.

  @return     VOID.

**/
VOID
IoCsrWrite32 (
  IN UINTN   Select,
  IN UINT32  Value
  );

/**
  IO CSR write double word operation. Only for LoongArch64.

  @param[in]  Select   IO CSR write instruction select values.
  @param[in]  Value    The iocsrwr.d will write the value.

  @return     VOID.

**/
VOID
IoCsrWrite64 (
  IN UINTN   Select,
  IN UINT64  Value
  );

#endif // defined (MDE_CPU_LOONGARCH64)

//
// String Services
//


/**
  Returns the length of a Null-terminated Unicode string.


UINTN
EFIAPI
StrnLenS (
  IN CONST CHAR16  *String,
  IN UINTN         MaxSize
  );

/**

UINTN
EFIAPI
StrnSizeS (
  IN CONST CHAR16  *String,
  IN UINTN         MaxSize
  );

/**

RETURN_STATUS
EFIAPI
StrCpyS (
  OUT CHAR16        *Destination,
  IN  UINTN         DestMax,
  IN  CONST CHAR16  *Source
  );

/**

RETURN_STATUS
EFIAPI
StrnCpyS (
  OUT CHAR16        *Destination,
  IN  UINTN         DestMax,
  IN  CONST CHAR16  *Source,
  IN  UINTN         Length
  );

/**

RETURN_STATUS
EFIAPI
StrCatS (
  IN OUT CHAR16        *Destination,
  IN     UINTN         DestMax,
  IN     CONST CHAR16  *Source
  );

/**

RETURN_STATUS
EFIAPI
StrnCatS (
  IN OUT CHAR16        *Destination,
  IN     UINTN         DestMax,
  IN     CONST CHAR16  *Source,
  IN     UINTN         Length
  );

/**

RETURN_STATUS
EFIAPI
StrDecimalToUintnS (
  IN  CONST CHAR16  *String,
  OUT       CHAR16  **EndPointer   OPTIONAL,
  OUT       UINTN   *Data
  );

/**

RETURN_STATUS
EFIAPI
StrDecimalToUint64S (
  IN  CONST CHAR16  *String,
  OUT       CHAR16  **EndPointer   OPTIONAL,
  OUT       UINT64  *Data
  );

/**

RETURN_STATUS
EFIAPI
StrHexToUintnS (
  IN  CONST CHAR16  *String,
  OUT       CHAR16  **EndPointer   OPTIONAL,
  OUT       UINTN   *Data
  );

/**

RETURN_STATUS
EFIAPI
StrHexToUint64S (
  IN  CONST CHAR16  *String,
  OUT       CHAR16  **EndPointer   OPTIONAL,
  OUT       UINT64  *Data
  );

/**

UINTN
EFIAPI
AsciiStrnLenS (
  IN CONST CHAR8  *String,
  IN UINTN        MaxSize
  );

/**

UINTN
EFIAPI
AsciiStrnSizeS (
  IN CONST CHAR8  *String,
  IN UINTN        MaxSize
  );

/**

RETURN_STATUS
EFIAPI
AsciiStrDecimalToUintnS (
  IN  CONST CHAR8  *String,
  OUT       CHAR8  **EndPointer   OPTIONAL,
  OUT       UINTN  *Data
  );

/**

RETURN_STATUS
EFIAPI
AsciiStrDecimalToUint64S (
  IN  CONST CHAR8   *String,
  OUT       CHAR8   **EndPointer   OPTIONAL,
  OUT       UINT64  *Data
  );

/**

RETURN_STATUS
EFIAPI
AsciiStrHexToUintnS (
  IN  CONST CHAR8  *String,
  OUT       CHAR8  **EndPointer   OPTIONAL,
  OUT       UINTN  *Data
  );

/**

RETURN_STATUS
EFIAPI
AsciiStrHexToUint64S (
  IN  CONST CHAR8   *String,
  OUT       CHAR8   **EndPointer   OPTIONAL,
  OUT       UINT64  *Data
  );


#ifndef DISABLE_NEW_DEPRECATED_INTERFACES

/**
  [ATTENTION] This function is deprecated for security reason.

  Copies one Null-terminated Unicode string to another Null-terminated Unicode
  string and returns the new Unicode string.

  This function copies the contents of the Unicode string Source to the Unicode
  string Destination, and returns Destination. If Source and Destination
  overlap, then the results are undefined.

  If Destination is NULL, then ASSERT().
  If Destination is not aligned on a 16-bit boundary, then ASSERT().
  If Source is NULL, then ASSERT().
  If Source is not aligned on a 16-bit boundary, then ASSERT().
  If Source and Destination overlap, then ASSERT().
  If PcdMaximumUnicodeStringLength is not zero, and Source contains more than
  PcdMaximumUnicodeStringLength Unicode characters not including the
  Null-terminator, then ASSERT().

  @param  Destination The pointer to a Null-terminated Unicode string.
  @param  Source      The pointer to a Null-terminated Unicode string.

  @return Destination.

**/
CHAR16 *
EFIAPI
StrCpy (
  OUT     CHAR16                    *Destination,
  IN      CONST CHAR16              *Source
  );


/**
  [ATTENTION] This function is deprecated for security reason.

  Copies up to a specified length from one Null-terminated Unicode string to
  another Null-terminated Unicode string and returns the new Unicode string.

  This function copies the contents of the Unicode string Source to the Unicode
  string Destination, and returns Destination. At most, Length Unicode
  characters are copied from Source to Destination. If Length is 0, then
  Destination is returned unmodified. If Length is greater that the number of
  Unicode characters in Source, then Destination is padded with Null Unicode
  characters. If Source and Destination overlap, then the results are
  undefined.

  If Length > 0 and Destination is NULL, then ASSERT().
  If Length > 0 and Destination is not aligned on a 16-bit boundary, then ASSERT().
  If Length > 0 and Source is NULL, then ASSERT().
  If Length > 0 and Source is not aligned on a 16-bit boundary, then ASSERT().
  If Source and Destination overlap, then ASSERT().
  If PcdMaximumUnicodeStringLength is not zero, and Length is greater than
  PcdMaximumUnicodeStringLength, then ASSERT().
  If PcdMaximumUnicodeStringLength is not zero, and Source contains more than
  PcdMaximumUnicodeStringLength Unicode characters, not including the Null-terminator,
  then ASSERT().

  @param  Destination The pointer to a Null-terminated Unicode string.
  @param  Source      The pointer to a Null-terminated Unicode string.
  @param  Length      The maximum number of Unicode characters to copy.

  @return Destination.

**/
CHAR16 *
EFIAPI
StrnCpy (
  OUT     CHAR16                    *Destination,
  IN      CONST CHAR16              *Source,
  IN      UINTN                     Length
  );
#endif // !defined (DISABLE_NEW_DEPRECATED_INTERFACES)

/**
  Returns the length of a Null-terminated Unicode string.

UINTN
EFIAPI
StrLen (
  IN      CONST CHAR16  *String
  );


/**
  Returns the size of a Null-terminated Unicode string in bytes, including the
  Null terminator.

UINTN
EFIAPI
StrSize (
  IN      CONST CHAR16  *String
  );


/**
  Compares two Null-terminated Unicode strings, and returns the difference
  between the first mismatched Unicode characters.

INTN
EFIAPI
StrCmp (
  IN      CONST CHAR16  *FirstString,
  IN      CONST CHAR16  *SecondString
  );


/**
  Compares up to a specified length the contents of two Null-terminated Unicode strings,
  and returns the difference between the first mismatched Unicode characters.

INTN
EFIAPI
StrnCmp (
  IN      CONST CHAR16  *FirstString,
  IN      CONST CHAR16  *SecondString,
  IN      UINTN         Length
  );


#ifndef DISABLE_NEW_DEPRECATED_INTERFACES

/**
  [ATTENTION] This function is deprecated for security reason.

  Concatenates one Null-terminated Unicode string to another Null-terminated
  Unicode string, and returns the concatenated Unicode string.

  This function concatenates two Null-terminated Unicode strings. The contents
  of Null-terminated Unicode string Source are concatenated to the end of
  Null-terminated Unicode string Destination. The Null-terminated concatenated
  Unicode String is returned. If Source and Destination overlap, then the
  results are undefined.

  If Destination is NULL, then ASSERT().
  If Destination is not aligned on a 16-bit boundary, then ASSERT().
  If Source is NULL, then ASSERT().
  If Source is not aligned on a 16-bit boundary, then ASSERT().
  If Source and Destination overlap, then ASSERT().
  If PcdMaximumUnicodeStringLength is not zero, and Destination contains more
  than PcdMaximumUnicodeStringLength Unicode characters, not including the
  Null-terminator, then ASSERT().
  If PcdMaximumUnicodeStringLength is not zero, and Source contains more than
  PcdMaximumUnicodeStringLength Unicode characters, not including the
  Null-terminator, then ASSERT().
  If PcdMaximumUnicodeStringLength is not zero, and concatenating Destination
  and Source results in a Unicode string with more than
  PcdMaximumUnicodeStringLength Unicode characters, not including the
  Null-terminator, then ASSERT().

  @param  Destination The pointer to a Null-terminated Unicode string.
  @param  Source      The pointer to a Null-terminated Unicode string.

  @return Destination.

**/
CHAR16 *
EFIAPI
StrCat (
  IN OUT  CHAR16                    *Destination,
  IN      CONST CHAR16              *Source
  );


/**
  [ATTENTION] This function is deprecated for security reason.

  Concatenates up to a specified length one Null-terminated Unicode to the end
  of another Null-terminated Unicode string, and returns the concatenated
  Unicode string.

  This function concatenates two Null-terminated Unicode strings. The contents
  of Null-terminated Unicode string Source are concatenated to the end of
  Null-terminated Unicode string Destination, and Destination is returned. At
  most, Length Unicode characters are concatenated from Source to the end of
  Destination, and Destination is always Null-terminated. If Length is 0, then
  Destination is returned unmodified. If Source and Destination overlap, then
  the results are undefined.

  If Destination is NULL, then ASSERT().
  If Length > 0 and Destination is not aligned on a 16-bit boundary, then ASSERT().
  If Length > 0 and Source is NULL, then ASSERT().
  If Length > 0 and Source is not aligned on a 16-bit boundary, then ASSERT().
  If Source and Destination overlap, then ASSERT().
  If PcdMaximumUnicodeStringLength is not zero, and Length is greater than
  PcdMaximumUnicodeStringLength, then ASSERT().
  If PcdMaximumUnicodeStringLength is not zero, and Destination contains more
  than PcdMaximumUnicodeStringLength Unicode characters, not including the
  Null-terminator, then ASSERT().
  If PcdMaximumUnicodeStringLength is not zero, and Source contains more than
  PcdMaximumUnicodeStringLength Unicode characters, not including the
  Null-terminator, then ASSERT().
  If PcdMaximumUnicodeStringLength is not zero, and concatenating Destination
  and Source results in a Unicode string with more than PcdMaximumUnicodeStringLength
  Unicode characters, not including the Null-terminator, then ASSERT().

  @param  Destination The pointer to a Null-terminated Unicode string.
  @param  Source      The pointer to a Null-terminated Unicode string.
  @param  Length      The maximum number of Unicode characters to concatenate from
                      Source.

  @return Destination.

**/
CHAR16 *
EFIAPI
StrnCat (
  IN OUT  CHAR16                    *Destination,
  IN      CONST CHAR16              *Source,
  IN      UINTN                     Length
  );
#endif // !defined (DISABLE_NEW_DEPRECATED_INTERFACES)

/**
  Returns the first occurrence of a Null-terminated Unicode sub-string

CHAR16 *
EFIAPI
StrStr (
  IN      CONST CHAR16  *String,
  IN      CONST CHAR16  *SearchString
  );

/**

UINTN
EFIAPI
StrDecimalToUintn (
  IN      CONST CHAR16  *String
  );

/**

UINT64
EFIAPI
StrDecimalToUint64 (
  IN      CONST CHAR16  *String
  );


/**
  Convert a Null-terminated Unicode hexadecimal string to a value of type UINTN.


UINTN
EFIAPI
StrHexToUintn (
  IN      CONST CHAR16  *String
  );


/**
  Convert a Null-terminated Unicode hexadecimal string to a value of type UINT64.


UINT64
EFIAPI
StrHexToUint64 (
  IN      CONST CHAR16  *String
  );

/**

RETURN_STATUS
EFIAPI
StrToIpv6Address (
  IN  CONST CHAR16  *String,
  OUT CHAR16        **EndPointer  OPTIONAL,
  OUT IPv6_ADDRESS  *Address,
  OUT UINT8         *PrefixLength OPTIONAL
  );

/**

RETURN_STATUS
EFIAPI
StrToIpv4Address (
  IN  CONST CHAR16  *String,
  OUT CHAR16        **EndPointer  OPTIONAL,
  OUT IPv4_ADDRESS  *Address,
  OUT UINT8         *PrefixLength OPTIONAL
  );

#define GUID_STRING_LENGTH  36

RETURN_STATUS
EFIAPI
StrToGuid (
  IN  CONST CHAR16  *String,
  OUT GUID          *Guid
  );

/**

RETURN_STATUS
EFIAPI
StrHexToBytes (
  IN  CONST CHAR16  *String,
  IN  UINTN         Length,
  OUT UINT8         *Buffer,
  IN  UINTN         MaxBufferSize
  );

#ifndef DISABLE_NEW_DEPRECATED_INTERFACES

/**
  [ATTENTION] This function is deprecated for security reason.

  Convert a Null-terminated Unicode string to a Null-terminated
  ASCII string and returns the ASCII string.

  This function converts the content of the Unicode string Source
  to the ASCII string Destination by copying the lower 8 bits of
  each Unicode character. It returns Destination.

  The caller is responsible to make sure Destination points to a buffer with size
  equal or greater than ((StrLen (Source) + 1) * sizeof (CHAR8)) in bytes.

  If any Unicode characters in Source contain non-zero value in
  the upper 8 bits, then ASSERT().

  If Destination is NULL, then ASSERT().
  If Source is NULL, then ASSERT().
  If Source is not aligned on a 16-bit boundary, then ASSERT().
  If Source and Destination overlap, then ASSERT().

  If PcdMaximumUnicodeStringLength is not zero, and Source contains
  more than PcdMaximumUnicodeStringLength Unicode characters not including
  the Null-terminator, then ASSERT().

  If PcdMaximumAsciiStringLength is not zero, and Source contains more
  than PcdMaximumAsciiStringLength Unicode characters not including the
  Null-terminator, then ASSERT().

  @param  Source        The pointer to a Null-terminated Unicode string.
  @param  Destination   The pointer to a Null-terminated ASCII string.

  @return Destination.

**/
CHAR8 *
EFIAPI
UnicodeStrToAsciiStr (
  IN      CONST CHAR16              *Source,
  OUT     CHAR8                     *Destination
  );

#endif // !defined (DISABLE_NEW_DEPRECATED_INTERFACES)

/**
  Convert a Null-terminated Unicode string to a Null-terminated
  ASCII string.

RETURN_STATUS
EFIAPI
UnicodeStrToAsciiStrS (
  IN      CONST CHAR16  *Source,
  OUT     CHAR8         *Destination,
  IN      UINTN         DestMax
  );

/**

RETURN_STATUS
EFIAPI
UnicodeStrnToAsciiStrS (
  IN      CONST CHAR16  *Source,
  IN      UINTN         Length,
  OUT     CHAR8         *Destination,
  IN      UINTN         DestMax,
  OUT     UINTN         *DestinationLength
  );

#ifndef DISABLE_NEW_DEPRECATED_INTERFACES

/**
  [ATTENTION] This function is deprecated for security reason.

  Copies one Null-terminated ASCII string to another Null-terminated ASCII
  string and returns the new ASCII string.

  This function copies the contents of the ASCII string Source to the ASCII
  string Destination, and returns Destination. If Source and Destination
  overlap, then the results are undefined.

  If Destination is NULL, then ASSERT().
  If Source is NULL, then ASSERT().
  If Source and Destination overlap, then ASSERT().
  If PcdMaximumAsciiStringLength is not zero and Source contains more than
  PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
  then ASSERT().

  @param  Destination The pointer to a Null-terminated ASCII string.
  @param  Source      The pointer to a Null-terminated ASCII string.

  @return Destination

**/
CHAR8 *
EFIAPI
AsciiStrCpy (
  OUT     CHAR8                     *Destination,
  IN      CONST CHAR8               *Source
  );


/**
  [ATTENTION] This function is deprecated for security reason.

  Copies up to a specified length one Null-terminated ASCII string to another
  Null-terminated ASCII string and returns the new ASCII string.

  This function copies the contents of the ASCII string Source to the ASCII
  string Destination, and returns Destination. At most, Length ASCII characters
  are copied from Source to Destination. If Length is 0, then Destination is
  returned unmodified. If Length is greater that the number of ASCII characters
  in Source, then Destination is padded with Null ASCII characters. If Source
  and Destination overlap, then the results are undefined.

  If Destination is NULL, then ASSERT().
  If Source is NULL, then ASSERT().
  If Source and Destination overlap, then ASSERT().
  If PcdMaximumAsciiStringLength is not zero, and Length is greater than
  PcdMaximumAsciiStringLength, then ASSERT().
  If PcdMaximumAsciiStringLength is not zero, and Source contains more than
  PcdMaximumAsciiStringLength ASCII characters, not including the Null-terminator,
  then ASSERT().

  @param  Destination The pointer to a Null-terminated ASCII string.
  @param  Source      The pointer to a Null-terminated ASCII string.
  @param  Length      The maximum number of ASCII characters to copy.

  @return Destination

**/
CHAR8 *
EFIAPI
AsciiStrnCpy (
  OUT     CHAR8                     *Destination,
  IN      CONST CHAR8               *Source,
  IN      UINTN                     Length
  );
#endif // !defined (DISABLE_NEW_DEPRECATED_INTERFACES)

/**
  Returns the length of a Null-terminated ASCII string.


UINTN
EFIAPI
AsciiStrLen (
  IN      CONST CHAR8  *String
  );


/**
  Returns the size of a Null-terminated ASCII string in bytes, including the
  Null terminator.

UINTN
EFIAPI
AsciiStrSize (
  IN      CONST CHAR8  *String
  );


/**
  Compares two Null-terminated ASCII strings, and returns the difference
  between the first mismatched ASCII characters.

INTN
EFIAPI
AsciiStrCmp (
  IN      CONST CHAR8  *FirstString,
  IN      CONST CHAR8  *SecondString
  );


/**
  Performs a case insensitive comparison of two Null-terminated ASCII strings,
  and returns the difference between the first mismatched ASCII characters.

INTN
EFIAPI
AsciiStriCmp (
  IN      CONST CHAR8  *FirstString,
  IN      CONST CHAR8  *SecondString
  );


/**
  Compares two Null-terminated ASCII strings with maximum lengths, and returns
  the difference between the first mismatched ASCII characters.

INTN
EFIAPI
AsciiStrnCmp (
  IN      CONST CHAR8  *FirstString,
  IN      CONST CHAR8  *SecondString,
  IN      UINTN        Length
  );


#ifndef DISABLE_NEW_DEPRECATED_INTERFACES

/**
  [ATTENTION] This function is deprecated for security reason.

  Concatenates one Null-terminated ASCII string to another Null-terminated
  ASCII string, and returns the concatenated ASCII string.

  This function concatenates two Null-terminated ASCII strings. The contents of
  Null-terminated ASCII string Source are concatenated to the end of Null-
  terminated ASCII string Destination. The Null-terminated concatenated ASCII
  String is returned.

  If Destination is NULL, then ASSERT().
  If Source is NULL, then ASSERT().
  If PcdMaximumAsciiStringLength is not zero and Destination contains more than
  PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
  then ASSERT().
  If PcdMaximumAsciiStringLength is not zero and Source contains more than
  PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
  then ASSERT().
  If PcdMaximumAsciiStringLength is not zero and concatenating Destination and
  Source results in a ASCII string with more than PcdMaximumAsciiStringLength
  ASCII characters, then ASSERT().

  @param  Destination The pointer to a Null-terminated ASCII string.
  @param  Source      The pointer to a Null-terminated ASCII string.

  @return Destination

**/
CHAR8 *
EFIAPI
AsciiStrCat (
  IN OUT CHAR8    *Destination,
  IN CONST CHAR8  *Source
  );


/**
  [ATTENTION] This function is deprecated for security reason.

  Concatenates up to a specified length one Null-terminated ASCII string to
  the end of another Null-terminated ASCII string, and returns the
  concatenated ASCII string.

  This function concatenates two Null-terminated ASCII strings. The contents
  of Null-terminated ASCII string Source are concatenated to the end of Null-
  terminated ASCII string Destination, and Destination is returned. At most,
  Length ASCII characters are concatenated from Source to the end of
  Destination, and Destination is always Null-terminated. If Length is 0, then
  Destination is returned unmodified. If Source and Destination overlap, then
  the results are undefined.

  If Length > 0 and Destination is NULL, then ASSERT().
  If Length > 0 and Source is NULL, then ASSERT().
  If Source and Destination overlap, then ASSERT().
  If PcdMaximumAsciiStringLength is not zero, and Length is greater than
  PcdMaximumAsciiStringLength, then ASSERT().
  If PcdMaximumAsciiStringLength is not zero, and Destination contains more than
  PcdMaximumAsciiStringLength ASCII characters, not including the Null-terminator,
  then ASSERT().
  If PcdMaximumAsciiStringLength is not zero, and Source contains more than
  PcdMaximumAsciiStringLength ASCII characters, not including the Null-terminator,
  then ASSERT().
  If PcdMaximumAsciiStringLength is not zero, and concatenating Destination and
  Source results in a ASCII string with more than PcdMaximumAsciiStringLength
  ASCII characters, not including the Null-terminator, then ASSERT().

  @param  Destination The pointer to a Null-terminated ASCII string.
  @param  Source      The pointer to a Null-terminated ASCII string.
  @param  Length      The maximum number of ASCII characters to concatenate from
                      Source.

  @return Destination

**/
CHAR8 *
EFIAPI
AsciiStrnCat (
  IN OUT  CHAR8                     *Destination,
  IN      CONST CHAR8               *Source,
  IN      UINTN                     Length
  );
#endif // !defined (DISABLE_NEW_DEPRECATED_INTERFACES)

/**
  Returns the first occurrence of a Null-terminated ASCII sub-string
  in a Null-terminated ASCII string.

CHAR8 *
EFIAPI
AsciiStrStr (
  IN      CONST CHAR8  *String,
  IN      CONST CHAR8  *SearchString
  );


/**
  Convert a Null-terminated ASCII decimal string to a value of type
  UINTN.

UINTN
EFIAPI
AsciiStrDecimalToUintn (
  IN      CONST CHAR8  *String
  );


/**
  Convert a Null-terminated ASCII decimal string to a value of type
  UINT64.

UINT64
EFIAPI
AsciiStrDecimalToUint64 (
  IN      CONST CHAR8  *String
  );


/**
  Convert a Null-terminated ASCII hexadecimal string to a value of type UINTN.


UINTN
EFIAPI
AsciiStrHexToUintn (
  IN      CONST CHAR8  *String
  );


/**
  Convert a Null-terminated ASCII hexadecimal string to a value of type UINT64.


UINT64
EFIAPI
AsciiStrHexToUint64 (
  IN      CONST CHAR8  *String
  );

/**

RETURN_STATUS
EFIAPI
AsciiStrToIpv6Address (
  IN  CONST CHAR8   *String,
  OUT CHAR8         **EndPointer  OPTIONAL,
  OUT IPv6_ADDRESS  *Address,
  OUT UINT8         *PrefixLength OPTIONAL
  );

/**

RETURN_STATUS
EFIAPI
AsciiStrToIpv4Address (
  IN  CONST CHAR8   *String,
  OUT CHAR8         **EndPointer  OPTIONAL,
  OUT IPv4_ADDRESS  *Address,
  OUT UINT8         *PrefixLength OPTIONAL
  );

/**

RETURN_STATUS
EFIAPI
AsciiStrToGuid (
  IN  CONST CHAR8  *String,
  OUT GUID         *Guid
  );

/**

RETURN_STATUS
EFIAPI
AsciiStrHexToBytes (
  IN  CONST CHAR8  *String,
  IN  UINTN        Length,
  OUT UINT8        *Buffer,
  IN  UINTN        MaxBufferSize
  );

#ifndef DISABLE_NEW_DEPRECATED_INTERFACES

/**
  [ATTENTION] This function is deprecated for security reason.

  Convert one Null-terminated ASCII string to a Null-terminated
  Unicode string and returns the Unicode string.

  This function converts the contents of the ASCII string Source to the Unicode
  string Destination, and returns Destination.  The function terminates the
  Unicode string Destination by appending a Null-terminator character at the end.
  The caller is responsible to make sure Destination points to a buffer with size
  equal or greater than ((AsciiStrLen (Source) + 1) * sizeof (CHAR16)) in bytes.

  If Destination is NULL, then ASSERT().
  If Destination is not aligned on a 16-bit boundary, then ASSERT().
  If Source is NULL, then ASSERT().
  If Source and Destination overlap, then ASSERT().
  If PcdMaximumAsciiStringLength is not zero, and Source contains more than
  PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
  then ASSERT().
  If PcdMaximumUnicodeStringLength is not zero, and Source contains more than
  PcdMaximumUnicodeStringLength ASCII characters not including the
  Null-terminator, then ASSERT().

  @param  Source        The pointer to a Null-terminated ASCII string.
  @param  Destination   The pointer to a Null-terminated Unicode string.

  @return Destination.

**/
CHAR16 *
EFIAPI
AsciiStrToUnicodeStr (
  IN      CONST CHAR8               *Source,
  OUT     CHAR16                    *Destination
  );

#endif // !defined (DISABLE_NEW_DEPRECATED_INTERFACES)

/**
  Convert one Null-terminated ASCII string to a Null-terminated
  Unicode string.

RETURN_STATUS
EFIAPI
AsciiStrToUnicodeStrS (
  IN      CONST CHAR8  *Source,
  OUT     CHAR16       *Destination,
  IN      UINTN        DestMax
  );

/**

RETURN_STATUS
EFIAPI
AsciiStrnToUnicodeStrS (
  IN      CONST CHAR8  *Source,
  IN      UINTN        Length,
  OUT     CHAR16       *Destination,
  IN      UINTN        DestMax,
  OUT     UINTN        *DestinationLength
  );

/**

CHAR16
EFIAPI
CharToUpper (
  IN      CHAR16  Char
  );

/**

CHAR8
EFIAPI
AsciiCharToUpper (
  IN      CHAR8  Chr
  );

/**

EFIAPI
Base64Encode (
  IN  CONST UINT8  *Source,
  IN        UINTN  SourceLength,
  OUT       CHAR8  *Destination  OPTIONAL,
  IN OUT    UINTN  *DestinationSize
  );

RETURN_STATUS
EFIAPI
Base64Decode (
  IN     CONST CHAR8  *Source          OPTIONAL,
  IN     UINTN        SourceSize,
  OUT    UINT8        *Destination     OPTIONAL,
  IN OUT UINTN        *DestinationSize
  );

/**

UINT8
EFIAPI
DecimalToBcd8 (
  IN      UINT8  Value
  );


/**
  Converts an 8-bit BCD value to an 8-bit value.


UINT8
EFIAPI
BcdToDecimal8 (
  IN      UINT8  Value
  );

//

**/
BOOLEAN
EFIAPI
PathRemoveLastItem (
  IN OUT CHAR16  *Path
  );

/**


  @return       Returns Path, otherwise returns NULL to indicate that an error has occurred.
**/
CHAR16 *
EFIAPI
PathCleanUpDirectories (
  IN CHAR16  *Path
  );

//

BOOLEAN
EFIAPI
IsNodeInList (
  IN      CONST LIST_ENTRY  *FirstEntry,
  IN      CONST LIST_ENTRY  *SecondEntry
  );


/**
  Initializes the head node of a doubly linked list, and returns the pointer to
  the head node of the doubly linked list.

LIST_ENTRY *
EFIAPI
InitializeListHead (
  IN OUT  LIST_ENTRY  *ListHead
  );


/**
  Adds a node to the beginning of a doubly linked list, and returns the pointer
  to the head node of the doubly linked list.

LIST_ENTRY *
EFIAPI
InsertHeadList (
  IN OUT  LIST_ENTRY  *ListHead,
  IN OUT  LIST_ENTRY  *Entry
  );


/**
  Adds a node to the end of a doubly linked list, and returns the pointer to
  the head node of the doubly linked list.

LIST_ENTRY *
EFIAPI
InsertTailList (
  IN OUT  LIST_ENTRY  *ListHead,
  IN OUT  LIST_ENTRY  *Entry
  );


/**
  Retrieves the first node of a doubly linked list.


LIST_ENTRY *
EFIAPI
GetFirstNode (
  IN      CONST LIST_ENTRY  *List
  );


/**
  Retrieves the next node of a doubly linked list.


LIST_ENTRY *
EFIAPI
GetNextNode (
  IN      CONST LIST_ENTRY  *List,
  IN      CONST LIST_ENTRY  *Node
  );


/**
  Retrieves the previous node of a doubly linked list.


LIST_ENTRY *
EFIAPI
GetPreviousNode (
  IN      CONST LIST_ENTRY  *List,
  IN      CONST LIST_ENTRY  *Node
  );


/**
  Checks to see if a doubly linked list is empty or not.


BOOLEAN
EFIAPI
IsListEmpty (
  IN      CONST LIST_ENTRY  *ListHead
  );


/**
  Determines if a node in a doubly linked list is the head node of a the same
  doubly linked list.  This function is typically used to terminate a loop that

BOOLEAN
EFIAPI
IsNull (
  IN      CONST LIST_ENTRY  *List,
  IN      CONST LIST_ENTRY  *Node
  );


/**
  Determines if a node the last node in a doubly linked list.


BOOLEAN
EFIAPI
IsNodeAtEnd (
  IN      CONST LIST_ENTRY  *List,
  IN      CONST LIST_ENTRY  *Node
  );


/**
  Swaps the location of two nodes in a doubly linked list, and returns the
  first node after the swap.

LIST_ENTRY *
EFIAPI
SwapListEntries (
  IN OUT  LIST_ENTRY  *FirstEntry,
  IN OUT  LIST_ENTRY  *SecondEntry
  );


/**
  Removes a node from a doubly linked list, and returns the node that follows
  the removed node.

LIST_ENTRY *
EFIAPI
RemoveEntryList (
  IN      CONST LIST_ENTRY  *Entry
  );

//
// Math Services
//

/**
  Prototype for comparison function for any two element types.

  @param[in] Buffer1                  The pointer to first buffer.
  @param[in] Buffer2                  The pointer to second buffer.

  @retval 0                           Buffer1 equal to Buffer2.
  @return <0                          Buffer1 is less than Buffer2.
  @return >0                          Buffer1 is greater than Buffer2.
**/
typedef
INTN
(EFIAPI *BASE_SORT_COMPARE)(
  IN CONST VOID                 *Buffer1,
  IN CONST VOID                 *Buffer2
  );

/**
  This function is identical to perform QuickSort,
  except that is uses the pre-allocated buffer so the in place sorting does not need to
  allocate and free buffers constantly.

  Each element must be equal sized.

  if BufferToSort is NULL, then ASSERT.
  if CompareFunction is NULL, then ASSERT.
  if BufferOneElement is NULL, then ASSERT.
  if ElementSize is < 1, then ASSERT.

  if Count is < 2 then perform no action.

  @param[in, out] BufferToSort   on call a Buffer of (possibly sorted) elements
                                 on return a buffer of sorted elements
  @param[in] Count               the number of elements in the buffer to sort
  @param[in] ElementSize         Size of an element in bytes
  @param[in] CompareFunction     The function to call to perform the comparison
                                 of any 2 elements
  @param[out] BufferOneElement   Caller provided buffer whose size equals to ElementSize.
                                 It's used by QuickSort() for swapping in sorting.
**/
VOID
EFIAPI
QuickSort (
  IN OUT VOID                 *BufferToSort,
  IN CONST UINTN              Count,
  IN CONST UINTN              ElementSize,
  IN       BASE_SORT_COMPARE  CompareFunction,
  OUT VOID                    *BufferOneElement
  );

/**
  Shifts a 64-bit integer left between 0 and 63 bits. The low bits are filled
  with zeros. The shifted value is returned.

UINT64
EFIAPI
LShiftU64 (
  IN      UINT64  Operand,
  IN      UINTN   Count
  );


/**
  Shifts a 64-bit integer right between 0 and 63 bits. This high bits are
  filled with zeros. The shifted value is returned.

UINT64
EFIAPI
RShiftU64 (
  IN      UINT64  Operand,
  IN      UINTN   Count
  );


/**
  Shifts a 64-bit integer right between 0 and 63 bits. The high bits are filled
  with original integer's bit 63. The shifted value is returned.

UINT64
EFIAPI
ARShiftU64 (
  IN      UINT64  Operand,
  IN      UINTN   Count
  );


/**
  Rotates a 32-bit integer left between 0 and 31 bits, filling the low bits
  with the high bits that were rotated.

UINT32
EFIAPI
LRotU32 (
  IN      UINT32  Operand,
  IN      UINTN   Count
  );


/**
  Rotates a 32-bit integer right between 0 and 31 bits, filling the high bits
  with the low bits that were rotated.

UINT32
EFIAPI
RRotU32 (
  IN      UINT32  Operand,
  IN      UINTN   Count
  );


/**
  Rotates a 64-bit integer left between 0 and 63 bits, filling the low bits
  with the high bits that were rotated.

UINT64
EFIAPI
LRotU64 (
  IN      UINT64  Operand,
  IN      UINTN   Count
  );


/**
  Rotates a 64-bit integer right between 0 and 63 bits, filling the high bits
  with the high low bits that were rotated.

UINT64
EFIAPI
RRotU64 (
  IN      UINT64  Operand,
  IN      UINTN   Count
  );


/**
  Returns the bit position of the lowest bit set in a 32-bit value.


INTN
EFIAPI
LowBitSet32 (
  IN      UINT32  Operand
  );


/**
  Returns the bit position of the lowest bit set in a 64-bit value.


INTN
EFIAPI
LowBitSet64 (
  IN      UINT64  Operand
  );


/**
  Returns the bit position of the highest bit set in a 32-bit value. Equivalent
  to log2(x).

INTN
EFIAPI
HighBitSet32 (
  IN      UINT32  Operand
  );


/**
  Returns the bit position of the highest bit set in a 64-bit value. Equivalent
  to log2(x).

INTN
EFIAPI
HighBitSet64 (
  IN      UINT64  Operand
  );


/**
  Returns the value of the highest bit set in a 32-bit value. Equivalent to
  1 << log2(x).

UINT32
EFIAPI
GetPowerOfTwo32 (
  IN      UINT32  Operand
  );


/**
  Returns the value of the highest bit set in a 64-bit value. Equivalent to
  1 << log2(x).

UINT64
EFIAPI
GetPowerOfTwo64 (
  IN      UINT64  Operand
  );


/**
  Switches the endianness of a 16-bit integer.


UINT16
EFIAPI
SwapBytes16 (
  IN      UINT16  Value
  );


/**
  Switches the endianness of a 32-bit integer.


UINT32
EFIAPI
SwapBytes32 (
  IN      UINT32  Value
  );


/**
  Switches the endianness of a 64-bit integer.


UINT64
EFIAPI
SwapBytes64 (
  IN      UINT64  Value
  );


/**
  Multiples a 64-bit unsigned integer by a 32-bit unsigned integer and
  generates a 64-bit unsigned result.

UINT64
EFIAPI
MultU64x32 (
  IN      UINT64  Multiplicand,
  IN      UINT32  Multiplier
  );


/**
  Multiples a 64-bit unsigned integer by a 64-bit unsigned integer and
  generates a 64-bit unsigned result.

UINT64
EFIAPI
MultU64x64 (
  IN      UINT64  Multiplicand,
  IN      UINT64  Multiplier
  );


/**
  Multiples a 64-bit signed integer by a 64-bit signed integer and generates a
  64-bit signed result.

INT64
EFIAPI
MultS64x64 (
  IN      INT64  Multiplicand,
  IN      INT64  Multiplier
  );


/**
  Divides a 64-bit unsigned integer by a 32-bit unsigned integer and generates
  a 64-bit unsigned result.

UINT64
EFIAPI
DivU64x32 (
  IN      UINT64  Dividend,
  IN      UINT32  Divisor
  );


/**
  Divides a 64-bit unsigned integer by a 32-bit unsigned integer and generates
  a 32-bit unsigned remainder.

UINT32
EFIAPI
ModU64x32 (
  IN      UINT64  Dividend,
  IN      UINT32  Divisor
  );


/**
  Divides a 64-bit unsigned integer by a 32-bit unsigned integer and generates
  a 64-bit unsigned result and an optional 32-bit unsigned remainder.

UINT64
EFIAPI
DivU64x32Remainder (
  IN      UINT64  Dividend,
  IN      UINT32  Divisor,
  OUT     UINT32  *Remainder  OPTIONAL
  );


/**
  Divides a 64-bit unsigned integer by a 64-bit unsigned integer and generates
  a 64-bit unsigned result and an optional 64-bit unsigned remainder.

UINT64
EFIAPI
DivU64x64Remainder (
  IN      UINT64  Dividend,
  IN      UINT64  Divisor,
  OUT     UINT64  *Remainder  OPTIONAL
  );


/**
  Divides a 64-bit signed integer by a 64-bit signed integer and generates a
  64-bit signed result and a optional 64-bit signed remainder.

INT64
EFIAPI
DivS64x64Remainder (
  IN      INT64  Dividend,
  IN      INT64  Divisor,
  OUT     INT64  *Remainder  OPTIONAL
  );


/**
  Reads a 16-bit value from memory that may be unaligned.


UINT16
EFIAPI
ReadUnaligned16 (
  IN CONST UINT16  *Buffer
  );


/**
  Writes a 16-bit value to memory that may be unaligned.


UINT16
EFIAPI
WriteUnaligned16 (
  OUT UINT16  *Buffer,
  IN  UINT16  Value
  );


/**
  Reads a 24-bit value from memory that may be unaligned.


UINT32
EFIAPI
ReadUnaligned24 (
  IN CONST UINT32  *Buffer
  );


/**
  Writes a 24-bit value to memory that may be unaligned.


UINT32
EFIAPI
WriteUnaligned24 (
  OUT UINT32  *Buffer,
  IN  UINT32  Value
  );


/**
  Reads a 32-bit value from memory that may be unaligned.


UINT32
EFIAPI
ReadUnaligned32 (
  IN CONST UINT32  *Buffer
  );


/**
  Writes a 32-bit value to memory that may be unaligned.


UINT32
EFIAPI
WriteUnaligned32 (
  OUT UINT32  *Buffer,
  IN  UINT32  Value
  );


/**
  Reads a 64-bit value from memory that may be unaligned.


UINT64
EFIAPI
ReadUnaligned64 (
  IN CONST UINT64  *Buffer
  );


/**
  Writes a 64-bit value to memory that may be unaligned.


UINT64
EFIAPI
WriteUnaligned64 (
  OUT UINT64  *Buffer,
  IN  UINT64  Value
  );


//
// Bit Field Functions
//

UINT8
EFIAPI
BitFieldRead8 (
  IN      UINT8  Operand,
  IN      UINTN  StartBit,
  IN      UINTN  EndBit
  );


/**
  Writes a bit field to an 8-bit value, and returns the result.


UINT8
EFIAPI
BitFieldWrite8 (
  IN      UINT8  Operand,
  IN      UINTN  StartBit,
  IN      UINTN  EndBit,
  IN      UINT8  Value
  );


/**
  Reads a bit field from an 8-bit value, performs a bitwise OR, and returns the
  result.

UINT8
EFIAPI
BitFieldOr8 (
  IN      UINT8  Operand,
  IN      UINTN  StartBit,
  IN      UINTN  EndBit,
  IN      UINT8  OrData
  );


/**
  Reads a bit field from an 8-bit value, performs a bitwise AND, and returns
  the result.

UINT8
EFIAPI
BitFieldAnd8 (
  IN      UINT8  Operand,
  IN      UINTN  StartBit,
  IN      UINTN  EndBit,
  IN      UINT8  AndData
  );


/**
  Reads a bit field from an 8-bit value, performs a bitwise AND followed by a
  bitwise OR, and returns the result.

UINT8
EFIAPI
BitFieldAndThenOr8 (
  IN      UINT8  Operand,
  IN      UINTN  StartBit,
  IN      UINTN  EndBit,
  IN      UINT8  AndData,
  IN      UINT8  OrData
  );


/**
  Returns a bit field from a 16-bit value.


UINT16
EFIAPI
BitFieldRead16 (
  IN      UINT16  Operand,
  IN      UINTN   StartBit,
  IN      UINTN   EndBit
  );


/**
  Writes a bit field to a 16-bit value, and returns the result.


UINT16
EFIAPI
BitFieldWrite16 (
  IN      UINT16  Operand,
  IN      UINTN   StartBit,
  IN      UINTN   EndBit,
  IN      UINT16  Value
  );


/**
  Reads a bit field from a 16-bit value, performs a bitwise OR, and returns the
  result.

UINT16
EFIAPI
BitFieldOr16 (
  IN      UINT16  Operand,
  IN      UINTN   StartBit,
  IN      UINTN   EndBit,
  IN      UINT16  OrData
  );


/**
  Reads a bit field from a 16-bit value, performs a bitwise AND, and returns
  the result.

UINT16
EFIAPI
BitFieldAnd16 (
  IN      UINT16  Operand,
  IN      UINTN   StartBit,
  IN      UINTN   EndBit,
  IN      UINT16  AndData
  );


/**
  Reads a bit field from a 16-bit value, performs a bitwise AND followed by a
  bitwise OR, and returns the result.

UINT16
EFIAPI
BitFieldAndThenOr16 (
  IN      UINT16  Operand,
  IN      UINTN   StartBit,
  IN      UINTN   EndBit,
  IN      UINT16  AndData,
  IN      UINT16  OrData
  );


/**
  Returns a bit field from a 32-bit value.


UINT32
EFIAPI
BitFieldRead32 (
  IN      UINT32  Operand,
  IN      UINTN   StartBit,
  IN      UINTN   EndBit
  );


/**
  Writes a bit field to a 32-bit value, and returns the result.


UINT32
EFIAPI
BitFieldWrite32 (
  IN      UINT32  Operand,
  IN      UINTN   StartBit,
  IN      UINTN   EndBit,
  IN      UINT32  Value
  );


/**
  Reads a bit field from a 32-bit value, performs a bitwise OR, and returns the
  result.

UINT32
EFIAPI
BitFieldOr32 (
  IN      UINT32  Operand,
  IN      UINTN   StartBit,
  IN      UINTN   EndBit,
  IN      UINT32  OrData
  );


/**
  Reads a bit field from a 32-bit value, performs a bitwise AND, and returns
  the result.

UINT32
EFIAPI
BitFieldAnd32 (
  IN      UINT32  Operand,
  IN      UINTN   StartBit,
  IN      UINTN   EndBit,
  IN      UINT32  AndData
  );


/**
  Reads a bit field from a 32-bit value, performs a bitwise AND followed by a
  bitwise OR, and returns the result.

UINT32
EFIAPI
BitFieldAndThenOr32 (
  IN      UINT32  Operand,
  IN      UINTN   StartBit,
  IN      UINTN   EndBit,
  IN      UINT32  AndData,
  IN      UINT32  OrData
  );


/**
  Returns a bit field from a 64-bit value.


UINT64
EFIAPI
BitFieldRead64 (
  IN      UINT64  Operand,
  IN      UINTN   StartBit,
  IN      UINTN   EndBit
  );


/**
  Writes a bit field to a 64-bit value, and returns the result.


UINT64
EFIAPI
BitFieldWrite64 (
  IN      UINT64  Operand,
  IN      UINTN   StartBit,
  IN      UINTN   EndBit,
  IN      UINT64  Value
  );


/**
  Reads a bit field from a 64-bit value, performs a bitwise OR, and returns the
  result.

UINT64
EFIAPI
BitFieldOr64 (
  IN      UINT64  Operand,
  IN      UINTN   StartBit,
  IN      UINTN   EndBit,
  IN      UINT64  OrData
  );


/**
  Reads a bit field from a 64-bit value, performs a bitwise AND, and returns
  the result.

UINT64
EFIAPI
BitFieldAnd64 (
  IN      UINT64  Operand,
  IN      UINTN   StartBit,
  IN      UINTN   EndBit,
  IN      UINT64  AndData
  );


/**
  Reads a bit field from a 64-bit value, performs a bitwise AND followed by a
  bitwise OR, and returns the result.

UINT64
EFIAPI
BitFieldAndThenOr64 (
  IN      UINT64  Operand,
  IN      UINTN   StartBit,
  IN      UINTN   EndBit,
  IN      UINT64  AndData,
  IN      UINT64  OrData
  );

/**

UINT8
EFIAPI
BitFieldCountOnes32 (
  IN       UINT32  Operand,
  IN       UINTN   StartBit,
  IN       UINTN   EndBit
  );

/**

UINT8
EFIAPI
BitFieldCountOnes64 (
  IN       UINT64  Operand,
  IN       UINTN   StartBit,
  IN       UINTN   EndBit
  );

//

UINT8
EFIAPI
CalculateSum8 (
  IN      CONST UINT8  *Buffer,
  IN      UINTN        Length
  );


/**
  Returns the two's complement checksum of all elements in a buffer
  of 8-bit values.

UINT8
EFIAPI
CalculateCheckSum8 (
  IN      CONST UINT8  *Buffer,
  IN      UINTN        Length
  );


/**
  Returns the sum of all elements in a buffer of 16-bit values.  During
  calculation, the carry bits are dropped.

UINT16
EFIAPI
CalculateSum16 (
  IN      CONST UINT16  *Buffer,
  IN      UINTN         Length
  );


/**
  Returns the two's complement checksum of all elements in a buffer of
  16-bit values.

UINT16
EFIAPI
CalculateCheckSum16 (
  IN      CONST UINT16  *Buffer,
  IN      UINTN         Length
  );


/**
  Returns the sum of all elements in a buffer of 32-bit values. During
  calculation, the carry bits are dropped.

UINT32
EFIAPI
CalculateSum32 (
  IN      CONST UINT32  *Buffer,
  IN      UINTN         Length
  );


/**
  Returns the two's complement checksum of all elements in a buffer of
  32-bit values.

UINT32
EFIAPI
CalculateCheckSum32 (
  IN      CONST UINT32  *Buffer,
  IN      UINTN         Length
  );


/**
  Returns the sum of all elements in a buffer of 64-bit values.  During
  calculation, the carry bits are dropped.

UINT64
EFIAPI
CalculateSum64 (
  IN      CONST UINT64  *Buffer,
  IN      UINTN         Length
  );


/**
  Returns the two's complement checksum of all elements in a buffer of
  64-bit values.

UINT64
EFIAPI
CalculateCheckSum64 (
  IN      CONST UINT64  *Buffer,
  IN      UINTN         Length
  );

/**

**/
UINT32
EFIAPI
CalculateCrc32 (
  IN  VOID   *Buffer,
  IN  UINTN  Length
  );

/**
   Calculates the CRC16-ANSI checksum of the given buffer.

   @param[in]      Buffer        Pointer to the buffer.
   @param[in]      Length        Length of the buffer, in bytes.
   @param[in]      InitialValue  Initial value of the CRC.

   @return The CRC16-ANSI checksum.
**/
UINT16
EFIAPI
CalculateCrc16Ansi (
  IN  CONST VOID  *Buffer,
  IN  UINTN       Length,
  IN  UINT16      InitialValue
  );

//
// Initial value for the CRC16-ANSI algorithm, when no prior checksum has been calculated.
//
#define CRC16ANSI_INIT  0xffff

/**
   Calculates the CRC32c checksum of the given buffer.

   @param[in]      Buffer        Pointer to the buffer.
   @param[in]      Length        Length of the buffer, in bytes.
   @param[in]      InitialValue  Initial value of the CRC.

   @return The CRC32c checksum.
**/
UINT32
EFIAPI
CalculateCrc32c (
  IN CONST VOID  *Buffer,
  IN UINTN       Length,
  IN UINT32      InitialValue
  );

//


  @param  Context1        Context1 parameter passed into SwitchStack().
  @param  Context2        Context2 parameter passed into SwitchStack().

**/
typedef
VOID
(EFIAPI *SWITCH_STACK_ENTRY_POINT)(
  IN      VOID                      *Context1   OPTIONAL,
  IN      VOID                      *Context2   OPTIONAL
  );


/**
  Used to serialize load and store operations.


  VOID
  );


/**
  Saves the current CPU context that can be restored with a call to LongJump()
  and returns 0.

  OUT     BASE_LIBRARY_JUMP_BUFFER  *JumpBuffer
  );


/**
  Restores the CPU context that was saved with SetJump().


  IN      UINTN                     Value
  );


/**
  Enables CPU interrupts.


  VOID
  );


/**
  Disables CPU interrupts.


  VOID
  );


/**
  Disables CPU interrupts and returns the interrupt state prior to the disable
  operation.

  VOID
  );


/**
  Enables CPU interrupts for the smallest window required to capture any
  pending interrupts.

  VOID
  );


/**
  Retrieves the current CPU interrupt state.


  VOID
  );


/**
  Set the current CPU interrupt state.


BOOLEAN
EFIAPI
SetInterruptState (
  IN      BOOLEAN  InterruptState
  );


/**
  Requests CPU to pause for a short period of time.


  VOID
  );


/**
  Transfers control to a function starting with a new stack.


EFIAPI
SwitchStack (
  IN      SWITCH_STACK_ENTRY_POINT  EntryPoint,
  IN      VOID                      *Context1   OPTIONAL,
  IN      VOID                      *Context2   OPTIONAL,
  IN      VOID                      *NewStack,
  ...
  );


/**
  Generates a breakpoint on the CPU.


  VOID
  );


/**
  Executes an infinite loop.


  VOID
  );


/**
  Uses as a barrier to stop speculative execution.


  VOID
  );

#if defined (MDE_CPU_X64) || defined (MDE_CPU_IA32)

/**
  The TDCALL instruction causes a VM exit to the Intel TDX module.  It is
  used to call guest-side Intel TDX functions, either local or a TD exit
  to the host VMM, as selected by Leaf.

  @param[in]      Leaf        Leaf number of TDCALL instruction
  @param[in]      Arg1        Arg1
  @param[in]      Arg2        Arg2
  @param[in]      Arg3        Arg3
  @param[in,out]  Results  Returned result of the Leaf function

  @return 0               A successful call
  @return Other           See individual leaf functions
**/
UINTN
EFIAPI
TdCall (
  IN UINT64    Leaf,
  IN UINT64    Arg1,
  IN UINT64    Arg2,
  IN UINT64    Arg3,
  IN OUT VOID  *Results
  );

/**
  TDVMALL is a leaf function 0 for TDCALL. It helps invoke services from the
  host VMM to pass/receive information.

  @param[in]     Leaf        Number of sub-functions
  @param[in]     Arg1        Arg1
  @param[in]     Arg2        Arg2
  @param[in]     Arg3        Arg3
  @param[in]     Arg4        Arg4
  @param[in,out] Results     Returned result of the sub-function

  @return 0               A successful call
  @return Other           See individual sub-functions

**/
UINTN
EFIAPI
TdVmCall (
  IN UINT64    Leaf,
  IN UINT64    Arg1,
  IN UINT64    Arg2,
  IN UINT64    Arg3,
  IN UINT64    Arg4,
  IN OUT VOID  *Results
  );

/**
  Probe if TD is enabled.

  @return TRUE    TD is enabled.
  @return FALSE   TD is not enabled.
**/
BOOLEAN
EFIAPI
TdIsEnabled (
  VOID
  );

#endif

#if defined (MDE_CPU_X64)
//
// The page size for the PVALIDATE instruction
//
typedef enum {
  PvalidatePageSize4K = 0,
  PvalidatePageSize2MB,
} PVALIDATE_PAGE_SIZE;

//
// PVALIDATE Return Code.
//
#define PVALIDATE_RET_SUCCESS        0
#define PVALIDATE_RET_FAIL_INPUT     1
#define PVALIDATE_RET_SIZE_MISMATCH  6

//
// The PVALIDATE instruction did not make any changes to the RMP entry.
//
#define PVALIDATE_RET_NO_RMPUPDATE  255

/**
 Execute a PVALIDATE instruction to validate or to rescinds validation of a guest
 page's RMP entry.

 The instruction is available only when CPUID Fn8000_001F_EAX[SNP]=1.

 The function is available on X64.

 @param[in]    PageSize         The page size to use.
 @param[in]    Validate         If TRUE, validate the guest virtual address
                                otherwise invalidate the guest virtual address.
 @param[in]    Address          The guest virtual address.

 @retval PVALIDATE_RET_SUCCESS        The PVALIDATE instruction succeeded, and
                                      updated the RMP entry.
 @retval PVALIDATE_RET_NO_RMPUPDATE   The PVALIDATE instruction succeeded, but
                                      did not update the RMP entry.
 @return                              Failure code from the PVALIDATE
                                      instruction.
**/
UINT32
EFIAPI
AsmPvalidate (
  IN   PVALIDATE_PAGE_SIZE  PageSize,
  IN   BOOLEAN              Validate,
  IN   PHYSICAL_ADDRESS     Address
  );

//
// RDX settings for RMPADJUST
//
#define RMPADJUST_VMPL_MAX               3
#define RMPADJUST_VMPL_MASK              0xFF
#define RMPADJUST_VMPL_SHIFT             0
#define RMPADJUST_PERMISSION_MASK_MASK   0xFF
#define RMPADJUST_PERMISSION_MASK_SHIFT  8
#define RMPADJUST_VMSA_PAGE_BIT          BIT16

/**
  Adjusts the permissions of an SEV-SNP guest page.

  Executes a RMPADJUST instruction with the register state specified by Rax,
  Rcx, and Rdx. Returns Eax. This function is only available on X64.

  The instruction is available only when CPUID Fn8000_001F_EAX[SNP]=1.

  @param[in]  Rax   The value to load into RAX before executing the RMPADJUST
                    instruction.
  @param[in]  Rcx   The value to load into RCX before executing the RMPADJUST
                    instruction.
  @param[in]  Rdx   The value to load into RDX before executing the RMPADJUST
                    instruction.

  @return     Eax
**/
UINT32
EFIAPI
AsmRmpAdjust (
  IN      UINT64  Rax,
  IN      UINT64  Rcx,
  IN      UINT64  Rdx
  );

#endif

#if defined (MDE_CPU_IA32) || defined (MDE_CPU_X64)
///

///
typedef union {
  struct {
    UINT32    CF         : 1; ///< Carry Flag.
    UINT32    Reserved_0 : 1; ///< Reserved.
    UINT32    PF         : 1; ///< Parity Flag.
    UINT32    Reserved_1 : 1; ///< Reserved.
    UINT32    AF         : 1; ///< Auxiliary Carry Flag.
    UINT32    Reserved_2 : 1; ///< Reserved.
    UINT32    ZF         : 1; ///< Zero Flag.
    UINT32    SF         : 1; ///< Sign Flag.
    UINT32    TF         : 1; ///< Trap Flag.
    UINT32    IF         : 1; ///< Interrupt Enable Flag.
    UINT32    DF         : 1; ///< Direction Flag.
    UINT32    OF         : 1; ///< Overflow Flag.
    UINT32    IOPL       : 2; ///< I/O Privilege Level.
    UINT32    NT         : 1; ///< Nested Task.
    UINT32    Reserved_3 : 1; ///< Reserved.
  } Bits;
  UINT16    Uint16;
} IA32_FLAGS16;

///
typedef union {
  struct {
    UINT32    CF         : 1;  ///< Carry Flag.
    UINT32    Reserved_0 : 1;  ///< Reserved.
    UINT32    PF         : 1;  ///< Parity Flag.
    UINT32    Reserved_1 : 1;  ///< Reserved.
    UINT32    AF         : 1;  ///< Auxiliary Carry Flag.
    UINT32    Reserved_2 : 1;  ///< Reserved.
    UINT32    ZF         : 1;  ///< Zero Flag.
    UINT32    SF         : 1;  ///< Sign Flag.
    UINT32    TF         : 1;  ///< Trap Flag.
    UINT32    IF         : 1;  ///< Interrupt Enable Flag.
    UINT32    DF         : 1;  ///< Direction Flag.
    UINT32    OF         : 1;  ///< Overflow Flag.
    UINT32    IOPL       : 2;  ///< I/O Privilege Level.
    UINT32    NT         : 1;  ///< Nested Task.
    UINT32    Reserved_3 : 1;  ///< Reserved.
    UINT32    RF         : 1;  ///< Resume Flag.
    UINT32    VM         : 1;  ///< Virtual 8086 Mode.
    UINT32    AC         : 1;  ///< Alignment Check.
    UINT32    VIF        : 1;  ///< Virtual Interrupt Flag.
    UINT32    VIP        : 1;  ///< Virtual Interrupt Pending.
    UINT32    ID         : 1;  ///< ID Flag.
    UINT32    Reserved_4 : 10; ///< Reserved.
  } Bits;
  UINTN    UintN;
} IA32_EFLAGS32;

///

///
typedef union {
  struct {
    UINT32    PE         : 1;  ///< Protection Enable.
    UINT32    MP         : 1;  ///< Monitor Coprocessor.
    UINT32    EM         : 1;  ///< Emulation.
    UINT32    TS         : 1;  ///< Task Switched.
    UINT32    ET         : 1;  ///< Extension Type.
    UINT32    NE         : 1;  ///< Numeric Error.
    UINT32    Reserved_0 : 10; ///< Reserved.
    UINT32    WP         : 1;  ///< Write Protect.
    UINT32    Reserved_1 : 1;  ///< Reserved.
    UINT32    AM         : 1;  ///< Alignment Mask.
    UINT32    Reserved_2 : 10; ///< Reserved.
    UINT32    NW         : 1;  ///< Mot Write-through.
    UINT32    CD         : 1;  ///< Cache Disable.
    UINT32    PG         : 1;  ///< Paging.
  } Bits;
  UINTN    UintN;
} IA32_CR0;

///

///
typedef union {
  struct {
    UINT32    VME        : 1; ///< Virtual-8086 Mode Extensions.
    UINT32    PVI        : 1; ///< Protected-Mode Virtual Interrupts.
    UINT32    TSD        : 1; ///< Time Stamp Disable.
    UINT32    DE         : 1; ///< Debugging Extensions.
    UINT32    PSE        : 1; ///< Page Size Extensions.
    UINT32    PAE        : 1; ///< Physical Address Extension.
    UINT32    MCE        : 1; ///< Machine Check Enable.
    UINT32    PGE        : 1; ///< Page Global Enable.
    UINT32    PCE        : 1; ///< Performance Monitoring Counter
                              ///< Enable.
    UINT32    OSFXSR     : 1; ///< Operating System Support for
                              ///< FXSAVE and FXRSTOR instructions
    UINT32    OSXMMEXCPT : 1; ///< Operating System Support for
                              ///< Unmasked SIMD Floating Point
                              ///< Exceptions.
    UINT32    UMIP       : 1; ///< User-Mode Instruction Prevention.
    UINT32    LA57       : 1; ///< Linear Address 57bit.
    UINT32    VMXE       : 1; ///< VMX Enable.
    UINT32    SMXE       : 1; ///< SMX Enable.
    UINT32    Reserved_3 : 1; ///< Reserved.
    UINT32    FSGSBASE   : 1; ///< FSGSBASE Enable.
    UINT32    PCIDE      : 1; ///< PCID Enable.
    UINT32    OSXSAVE    : 1; ///< XSAVE and Processor Extended States Enable.
    UINT32    Reserved_4 : 1; ///< Reserved.
    UINT32    SMEP       : 1; ///< SMEP Enable.
    UINT32    SMAP       : 1; ///< SMAP Enable.
    UINT32    PKE        : 1; ///< Protection-Key Enable.
    UINT32    Reserved_5 : 9; ///< Reserved.
  } Bits;
  UINTN    UintN;
} IA32_CR4;

///

///
typedef union {
  struct {
    UINT32    LimitLow  : 16;
    UINT32    BaseLow   : 16;
    UINT32    BaseMid   : 8;
    UINT32    Type      : 4;
    UINT32    S         : 1;
    UINT32    DPL       : 2;
    UINT32    P         : 1;
    UINT32    LimitHigh : 4;
    UINT32    AVL       : 1;
    UINT32    L         : 1;
    UINT32    DB        : 1;
    UINT32    G         : 1;
    UINT32    BaseHigh  : 8;
  } Bits;
  UINT64    Uint64;
} IA32_SEGMENT_DESCRIPTOR;

///
/// Byte packed structure for an IDTR, GDTR, LDTR descriptor.
///
  #pragma pack (1)
typedef struct {
  UINT16    Limit;
  UINTN     Base;
} IA32_DESCRIPTOR;
  #pragma pack ()

#define IA32_IDT_GATE_TYPE_TASK          0x85
#define IA32_IDT_GATE_TYPE_INTERRUPT_16  0x86

#define IA32_IDT_GATE_TYPE_INTERRUPT_32  0x8E
#define IA32_IDT_GATE_TYPE_TRAP_32       0x8F

#define IA32_GDT_TYPE_TSS   0x9
#define IA32_GDT_ALIGNMENT  8

  #if defined (MDE_CPU_IA32)
///
/// Byte packed structure for an IA-32 Interrupt Gate Descriptor.
///
typedef union {
  struct {
    UINT32    OffsetLow  : 16; ///< Offset bits 15..0.
    UINT32    Selector   : 16; ///< Selector.
    UINT32    Reserved_0 : 8;  ///< Reserved.
    UINT32    GateType   : 8;  ///< Gate Type.  See #defines above.
    UINT32    OffsetHigh : 16; ///< Offset bits 31..16.
  } Bits;
  UINT64    Uint64;
} IA32_IDT_GATE_DESCRIPTOR;

    #pragma pack (1)
//
// IA32 Task-State Segment Definition
//


typedef union {
  struct {
    UINT32    LimitLow    : 16; ///< Segment Limit 15..00
    UINT32    BaseLow     : 16; ///< Base Address  15..00
    UINT32    BaseMid     : 8;  ///< Base Address  23..16
    UINT32    Type        : 4;  ///< Type (1 0 B 1)
    UINT32    Reserved_43 : 1;  ///< 0
    UINT32    DPL         : 2;  ///< Descriptor Privilege Level
    UINT32    P           : 1;  ///< Segment Present
    UINT32    LimitHigh   : 4;  ///< Segment Limit 19..16
    UINT32    AVL         : 1;  ///< Available for use by system software
    UINT32    Reserved_52 : 2;  ///< 0 0
    UINT32    G           : 1;  ///< Granularity
    UINT32    BaseHigh    : 8;  ///< Base Address 31..24
  } Bits;
  UINT64    Uint64;
} IA32_TSS_DESCRIPTOR;
    #pragma pack ()

  #endif // defined (MDE_CPU_IA32)

  #if defined (MDE_CPU_X64)
///
/// Byte packed structure for an x64 Interrupt Gate Descriptor.
///
typedef union {
  struct {
    UINT32    OffsetLow   : 16; ///< Offset bits 15..0.
    UINT32    Selector    : 16; ///< Selector.
    UINT32    Reserved_0  : 8;  ///< Reserved.
    UINT32    GateType    : 8;  ///< Gate Type.  See #defines above.
    UINT32    OffsetHigh  : 16; ///< Offset bits 31..16.
    UINT32    OffsetUpper : 32; ///< Offset bits 63..32.
    UINT32    Reserved_1  : 32; ///< Reserved.
  } Bits;
  struct {
    UINT64    Uint64;
    UINT64    Uint64_1;
  } Uint128;
} IA32_IDT_GATE_DESCRIPTOR;

    #pragma pack (1)
//
// IA32 Task-State Segment Definition
//


typedef union {
  struct {
    UINT32    LimitLow    : 16; ///< Segment Limit 15..00
    UINT32    BaseLow     : 16; ///< Base Address  15..00
    UINT32    BaseMidl    : 8;  ///< Base Address  23..16
    UINT32    Type        : 4;  ///< Type (1 0 B 1)
    UINT32    Reserved_43 : 1;  ///< 0
    UINT32    DPL         : 2;  ///< Descriptor Privilege Level
    UINT32    P           : 1;  ///< Segment Present
    UINT32    LimitHigh   : 4;  ///< Segment Limit 19..16
    UINT32    AVL         : 1;  ///< Available for use by system software
    UINT32    Reserved_52 : 2;  ///< 0 0
    UINT32    G           : 1;  ///< Granularity
    UINT32    BaseMidh    : 8;  ///< Base Address  31..24
    UINT32    BaseHigh    : 32; ///< Base Address  63..32
    UINT32    Reserved_96 : 32; ///< Reserved
  } Bits;
  struct {
    UINT64    Uint64;
    UINT64    Uint64_1;
  } Uint128;
} IA32_TSS_DESCRIPTOR;
    #pragma pack ()

  #endif // defined (MDE_CPU_X64)

///
/// Byte packed structure for an FP/SSE/SSE2 context.
///
typedef struct {
  UINT8    Buffer[512];
} IA32_FX_BUFFER;

///
/// Structures for the 16-bit real mode thunks.
///
typedef struct {
  UINT32    Reserved1;
  UINT32    Reserved2;
  UINT32    Reserved3;
  UINT32    Reserved4;
  UINT8     BL;
  UINT8     BH;
  UINT16    Reserved5;
  UINT8     DL;
  UINT8     DH;
  UINT16    Reserved6;
  UINT8     CL;
  UINT8     CH;
  UINT16    Reserved7;
  UINT8     AL;
  UINT8     AH;
  UINT16    Reserved8;
} IA32_BYTE_REGS;

typedef struct {
  UINT16    DI;
  UINT16    Reserved1;
  UINT16    SI;
  UINT16    Reserved2;
  UINT16    BP;
  UINT16    Reserved3;
  UINT16    SP;
  UINT16    Reserved4;
  UINT16    BX;
  UINT16    Reserved5;
  UINT16    DX;
  UINT16    Reserved6;
  UINT16    CX;
  UINT16    Reserved7;
  UINT16    AX;
  UINT16    Reserved8;
} IA32_WORD_REGS;

typedef struct {
  UINT32           EDI;
  UINT32           ESI;
  UINT32           EBP;
  UINT32           ESP;
  UINT32           EBX;
  UINT32           EDX;
  UINT32           ECX;
  UINT32           EAX;
  UINT16           DS;
  UINT16           ES;
  UINT16           FS;
  UINT16           GS;
  IA32_EFLAGS32    EFLAGS;
  UINT32           Eip;
  UINT16           CS;
  UINT16           SS;
} IA32_DWORD_REGS;

typedef union {
  IA32_DWORD_REGS    E;
  IA32_WORD_REGS     X;
  IA32_BYTE_REGS     H;
} IA32_REGISTER_SET;

///
/// Byte packed structure for an 16-bit real mode thunks.
///
typedef struct {
  IA32_REGISTER_SET    *RealModeState;
  VOID                 *RealModeBuffer;
  UINT32               RealModeBufferSize;
  UINT32               ThunkAttributes;
} THUNK_CONTEXT;

#define THUNK_ATTRIBUTE_BIG_REAL_MODE              0x00000001
#define THUNK_ATTRIBUTE_DISABLE_A20_MASK_INT_15    0x00000002
#define THUNK_ATTRIBUTE_DISABLE_A20_MASK_KBD_CTRL  0x00000004

///
/// Type definition for representing labels in NASM source code that allow for

/// edk2 coding style for function (or pointer-to-function) typedefs. The VOID
/// return type and the VOID argument list are merely artifacts.
///
typedef VOID (X86_ASSEMBLY_PATCH_LABEL) (
  VOID
  );

/**
  Retrieves CPUID information.

UINT32
EFIAPI
AsmCpuid (
  IN      UINT32  Index,
  OUT     UINT32  *Eax   OPTIONAL,
  OUT     UINT32  *Ebx   OPTIONAL,
  OUT     UINT32  *Ecx   OPTIONAL,
  OUT     UINT32  *Edx   OPTIONAL
  );


/**
  Retrieves CPUID information using an extended leaf identifier.


UINT32
EFIAPI
AsmCpuidEx (
  IN      UINT32  Index,
  IN      UINT32  SubIndex,
  OUT     UINT32  *Eax   OPTIONAL,
  OUT     UINT32  *Ebx   OPTIONAL,
  OUT     UINT32  *Ecx   OPTIONAL,
  OUT     UINT32  *Edx   OPTIONAL
  );


/**
  Set CD bit and clear NW bit of CR0 followed by a WBINVD.


  VOID
  );


/**
  Perform a WBINVD and clear both the CD and NW bits of CR0.


  VOID
  );


/**
  Returns the lower 32-bits of a Machine Specific Register(MSR).


UINT32
EFIAPI
AsmReadMsr32 (
  IN      UINT32  Index
  );


/**
  Writes a 32-bit value to a Machine Specific Register(MSR), and returns the value.
  The upper 32-bits of the MSR are set to zero.

UINT32
EFIAPI
AsmWriteMsr32 (
  IN      UINT32  Index,
  IN      UINT32  Value
  );


/**
  Reads a 64-bit MSR, performs a bitwise OR on the lower 32-bits, and
  writes the result back to the 64-bit MSR.

UINT32
EFIAPI
AsmMsrOr32 (
  IN      UINT32  Index,
  IN      UINT32  OrData
  );


/**
  Reads a 64-bit MSR, performs a bitwise AND on the lower 32-bits, and writes
  the result back to the 64-bit MSR.

UINT32
EFIAPI
AsmMsrAnd32 (
  IN      UINT32  Index,
  IN      UINT32  AndData
  );


/**
  Reads a 64-bit MSR, performs a bitwise AND followed by a bitwise OR
  on the lower 32-bits, and writes the result back to the 64-bit MSR.

UINT32
EFIAPI
AsmMsrAndThenOr32 (
  IN      UINT32  Index,
  IN      UINT32  AndData,
  IN      UINT32  OrData
  );


/**
  Reads a bit field of an MSR.


UINT32
EFIAPI
AsmMsrBitFieldRead32 (
  IN      UINT32  Index,
  IN      UINTN   StartBit,
  IN      UINTN   EndBit
  );


/**
  Writes a bit field to an MSR.


UINT32
EFIAPI
AsmMsrBitFieldWrite32 (
  IN      UINT32  Index,
  IN      UINTN   StartBit,
  IN      UINTN   EndBit,
  IN      UINT32  Value
  );


/**
  Reads a bit field in a 64-bit MSR, performs a bitwise OR, and writes the
  result back to the bit field in the 64-bit MSR.

UINT32
EFIAPI
AsmMsrBitFieldOr32 (
  IN      UINT32  Index,
  IN      UINTN   StartBit,
  IN      UINTN   EndBit,
  IN      UINT32  OrData
  );


/**
  Reads a bit field in a 64-bit MSR, performs a bitwise AND, and writes the
  result back to the bit field in the 64-bit MSR.

UINT32
EFIAPI
AsmMsrBitFieldAnd32 (
  IN      UINT32  Index,
  IN      UINTN   StartBit,
  IN      UINTN   EndBit,
  IN      UINT32  AndData
  );


/**
  Reads a bit field in a 64-bit MSR, performs a bitwise AND followed by a
  bitwise OR, and writes the result back to the bit field in the

UINT32
EFIAPI
AsmMsrBitFieldAndThenOr32 (
  IN      UINT32  Index,
  IN      UINTN   StartBit,
  IN      UINTN   EndBit,
  IN      UINT32  AndData,
  IN      UINT32  OrData
  );


/**
  Returns a 64-bit Machine Specific Register(MSR).


UINT64
EFIAPI
AsmReadMsr64 (
  IN      UINT32  Index
  );


/**
  Writes a 64-bit value to a Machine Specific Register(MSR), and returns the
  value.

UINT64
EFIAPI
AsmWriteMsr64 (
  IN      UINT32  Index,
  IN      UINT64  Value
  );


/**
  Reads a 64-bit MSR, performs a bitwise OR, and writes the result
  back to the 64-bit MSR.

UINT64
EFIAPI
AsmMsrOr64 (
  IN      UINT32  Index,
  IN      UINT64  OrData
  );


/**
  Reads a 64-bit MSR, performs a bitwise AND, and writes the result back to the
  64-bit MSR.

UINT64
EFIAPI
AsmMsrAnd64 (
  IN      UINT32  Index,
  IN      UINT64  AndData
  );


/**
  Reads a 64-bit MSR, performs a bitwise AND followed by a bitwise
  OR, and writes the result back to the 64-bit MSR.

UINT64
EFIAPI
AsmMsrAndThenOr64 (
  IN      UINT32  Index,
  IN      UINT64  AndData,
  IN      UINT64  OrData
  );


/**
  Reads a bit field of an MSR.


UINT64
EFIAPI
AsmMsrBitFieldRead64 (
  IN      UINT32  Index,
  IN      UINTN   StartBit,
  IN      UINTN   EndBit
  );


/**
  Writes a bit field to an MSR.


UINT64
EFIAPI
AsmMsrBitFieldWrite64 (
  IN      UINT32  Index,
  IN      UINTN   StartBit,
  IN      UINTN   EndBit,
  IN      UINT64  Value
  );


/**
  Reads a bit field in a 64-bit MSR, performs a bitwise OR, and
  writes the result back to the bit field in the 64-bit MSR.

UINT64
EFIAPI
AsmMsrBitFieldOr64 (
  IN      UINT32  Index,
  IN      UINTN   StartBit,
  IN      UINTN   EndBit,
  IN      UINT64  OrData
  );


/**
  Reads a bit field in a 64-bit MSR, performs a bitwise AND, and writes the
  result back to the bit field in the 64-bit MSR.

UINT64
EFIAPI
AsmMsrBitFieldAnd64 (
  IN      UINT32  Index,
  IN      UINTN   StartBit,
  IN      UINTN   EndBit,
  IN      UINT64  AndData
  );


/**
  Reads a bit field in a 64-bit MSR, performs a bitwise AND followed by a
  bitwise OR, and writes the result back to the bit field in the

UINT64
EFIAPI
AsmMsrBitFieldAndThenOr64 (
  IN      UINT32  Index,
  IN      UINTN   StartBit,
  IN      UINTN   EndBit,
  IN      UINT64  AndData,
  IN      UINT64  OrData
  );


/**
  Reads the current value of the EFLAGS register.


  VOID
  );


/**
  Reads the current value of the Control Register 0 (CR0).


  VOID
  );


/**
  Reads the current value of the Control Register 2 (CR2).


  VOID
  );


/**
  Reads the current value of the Control Register 3 (CR3).


  VOID
  );


/**
  Reads the current value of the Control Register 4 (CR4).


  VOID
  );


/**
  Writes a value to Control Register 0 (CR0).


  UINTN  Cr0
  );


/**
  Writes a value to Control Register 2 (CR2).


  UINTN  Cr2
  );


/**
  Writes a value to Control Register 3 (CR3).


  UINTN  Cr3
  );


/**
  Writes a value to Control Register 4 (CR4).


  UINTN  Cr4
  );


/**
  Reads the current value of Debug Register 0 (DR0).


  VOID
  );


/**
  Reads the current value of Debug Register 1 (DR1).


  VOID
  );


/**
  Reads the current value of Debug Register 2 (DR2).


  VOID
  );


/**
  Reads the current value of Debug Register 3 (DR3).


  VOID
  );


/**
  Reads the current value of Debug Register 4 (DR4).


  VOID
  );


/**
  Reads the current value of Debug Register 5 (DR5).


  VOID
  );


/**
  Reads the current value of Debug Register 6 (DR6).


  VOID
  );


/**
  Reads the current value of Debug Register 7 (DR7).


  VOID
  );


/**
  Writes a value to Debug Register 0 (DR0).


  UINTN  Dr0
  );


/**
  Writes a value to Debug Register 1 (DR1).


  UINTN  Dr1
  );


/**
  Writes a value to Debug Register 2 (DR2).


  UINTN  Dr2
  );


/**
  Writes a value to Debug Register 3 (DR3).


  UINTN  Dr3
  );


/**
  Writes a value to Debug Register 4 (DR4).


  UINTN  Dr4
  );


/**
  Writes a value to Debug Register 5 (DR5).


  UINTN  Dr5
  );


/**
  Writes a value to Debug Register 6 (DR6).


  UINTN  Dr6
  );


/**
  Writes a value to Debug Register 7 (DR7).


  UINTN  Dr7
  );


/**
  Reads the current value of Code Segment Register (CS).


  VOID
  );


/**
  Reads the current value of Data Segment Register (DS).


  VOID
  );


/**
  Reads the current value of Extra Segment Register (ES).


  VOID
  );


/**
  Reads the current value of FS Data Segment Register (FS).


  VOID
  );


/**
  Reads the current value of GS Data Segment Register (GS).


  VOID
  );


/**
  Reads the current value of Stack Segment Register (SS).


  VOID
  );


/**
  Reads the current value of Task Register (TR).


  VOID
  );


/**
  Reads the current Global Descriptor Table Register(GDTR) descriptor.


VOID
EFIAPI
AsmReadGdtr (
  OUT     IA32_DESCRIPTOR  *Gdtr
  );


/**
  Writes the current Global Descriptor Table Register (GDTR) descriptor.


VOID
EFIAPI
AsmWriteGdtr (
  IN      CONST IA32_DESCRIPTOR  *Gdtr
  );


/**
  Reads the current Interrupt Descriptor Table Register(IDTR) descriptor.


VOID
EFIAPI
AsmReadIdtr (
  OUT     IA32_DESCRIPTOR  *Idtr
  );


/**
  Writes the current Interrupt Descriptor Table Register(IDTR) descriptor.


VOID
EFIAPI
AsmWriteIdtr (
  IN      CONST IA32_DESCRIPTOR  *Idtr
  );


/**
  Reads the current Local Descriptor Table Register(LDTR) selector.


  VOID
  );


/**
  Writes the current Local Descriptor Table Register (LDTR) selector.


VOID
EFIAPI
AsmWriteLdtr (
  IN      UINT16  Ldtr
  );


/**
  Save the current floating point/SSE/SSE2 context to a buffer.


VOID
EFIAPI
AsmFxSave (
  OUT     IA32_FX_BUFFER  *Buffer
  );


/**
  Restores the current floating point/SSE/SSE2 context from a buffer.


VOID
EFIAPI
AsmFxRestore (
  IN      CONST IA32_FX_BUFFER  *Buffer
  );


/**
  Reads the current value of 64-bit MMX Register #0 (MM0).


  VOID
  );


/**
  Reads the current value of 64-bit MMX Register #1 (MM1).


  VOID
  );


/**
  Reads the current value of 64-bit MMX Register #2 (MM2).


  VOID
  );


/**
  Reads the current value of 64-bit MMX Register #3 (MM3).


  VOID
  );


/**
  Reads the current value of 64-bit MMX Register #4 (MM4).


  VOID
  );


/**
  Reads the current value of 64-bit MMX Register #5 (MM5).


  VOID
  );


/**
  Reads the current value of 64-bit MMX Register #6 (MM6).


  VOID
  );


/**
  Reads the current value of 64-bit MMX Register #7 (MM7).


  VOID
  );


/**
  Writes the current value of 64-bit MMX Register #0 (MM0).


VOID
EFIAPI
AsmWriteMm0 (
  IN      UINT64  Value
  );


/**
  Writes the current value of 64-bit MMX Register #1 (MM1).


VOID
EFIAPI
AsmWriteMm1 (
  IN      UINT64  Value
  );


/**
  Writes the current value of 64-bit MMX Register #2 (MM2).


VOID
EFIAPI
AsmWriteMm2 (
  IN      UINT64  Value
  );


/**
  Writes the current value of 64-bit MMX Register #3 (MM3).


VOID
EFIAPI
AsmWriteMm3 (
  IN      UINT64  Value
  );


/**
  Writes the current value of 64-bit MMX Register #4 (MM4).


VOID
EFIAPI
AsmWriteMm4 (
  IN      UINT64  Value
  );


/**
  Writes the current value of 64-bit MMX Register #5 (MM5).


VOID
EFIAPI
AsmWriteMm5 (
  IN      UINT64  Value
  );


/**
  Writes the current value of 64-bit MMX Register #6 (MM6).


VOID
EFIAPI
AsmWriteMm6 (
  IN      UINT64  Value
  );


/**
  Writes the current value of 64-bit MMX Register #7 (MM7).


VOID
EFIAPI
AsmWriteMm7 (
  IN      UINT64  Value
  );


/**
  Reads the current value of Time Stamp Counter (TSC).


  VOID
  );


/**
  Reads the current value of a Performance Counter (PMC).


UINT64
EFIAPI
AsmReadPmc (
  IN      UINT32  Index
  );


/**
  Sets up a monitor buffer that is used by AsmMwait().


UINTN
EFIAPI
AsmMonitor (
  IN      UINTN  Eax,
  IN      UINTN  Ecx,
  IN      UINTN  Edx
  );


/**
  Executes an MWAIT instruction.


UINTN
EFIAPI
AsmMwait (
  IN      UINTN  Eax,
  IN      UINTN  Ecx
  );


/**
  Executes a WBINVD instruction.


  VOID
  );


/**
  Executes a INVD instruction.


  VOID
  );


/**
  Flushes a cache line from all the instruction and data caches within the
  coherency domain of the CPU.

VOID *
EFIAPI
AsmFlushCacheLine (
  IN      VOID  *LinearAddress
  );


/**
  Enables the 32-bit paging mode on the CPU.


EFIAPI
AsmEnablePaging32 (
  IN      SWITCH_STACK_ENTRY_POINT  EntryPoint,
  IN      VOID                      *Context1   OPTIONAL,
  IN      VOID                      *Context2   OPTIONAL,
  IN      VOID                      *NewStack
  );


/**
  Disables the 32-bit paging mode on the CPU.


EFIAPI
AsmDisablePaging32 (
  IN      SWITCH_STACK_ENTRY_POINT  EntryPoint,
  IN      VOID                      *Context1   OPTIONAL,
  IN      VOID                      *Context2   OPTIONAL,
  IN      VOID                      *NewStack
  );


/**
  Enables the 64-bit paging mode on the CPU.


VOID
EFIAPI
AsmEnablePaging64 (
  IN      UINT16  Cs,
  IN      UINT64  EntryPoint,
  IN      UINT64  Context1   OPTIONAL,
  IN      UINT64  Context2   OPTIONAL,
  IN      UINT64  NewStack
  );


/**
  Disables the 64-bit paging mode on the CPU.


VOID
EFIAPI
AsmDisablePaging64 (
  IN      UINT16  Cs,
  IN      UINT32  EntryPoint,
  IN      UINT32  Context1   OPTIONAL,
  IN      UINT32  Context2   OPTIONAL,
  IN      UINT32  NewStack
  );


//
// 16-bit thunking services
//

VOID
EFIAPI
AsmGetThunk16Properties (
  OUT     UINT32  *RealModeBufferSize,
  OUT     UINT32  *ExtraStackSize
  );


/**
  Prepares all structures a code required to use AsmThunk16().


VOID
EFIAPI
AsmPrepareThunk16 (
  IN OUT  THUNK_CONTEXT  *ThunkContext
  );


/**
  Transfers control to a 16-bit real mode entry point and returns the results.


VOID
EFIAPI
AsmThunk16 (
  IN OUT  THUNK_CONTEXT  *ThunkContext
  );


/**
  Prepares all structures and code for a 16-bit real mode thunk, transfers
  control to a 16-bit real mode entry point, and returns the results.

VOID
EFIAPI
AsmPrepareAndThunk16 (
  IN OUT  THUNK_CONTEXT  *ThunkContext
  );

/**

BOOLEAN
EFIAPI
AsmRdRand16 (
  OUT     UINT16  *Rand
  );

/**

BOOLEAN
EFIAPI
AsmRdRand32 (
  OUT     UINT32  *Rand
  );

/**

BOOLEAN
EFIAPI
AsmRdRand64  (
  OUT     UINT64  *Rand
  );

/**

VOID
EFIAPI
AsmWriteTr (
  IN UINT16  Selector
  );

/**

  VOID
  );

/**
  Executes a XGETBV instruction

  Executes a XGETBV instruction. This function is only available on IA-32 and
  x64.

  @param[in] Index        Extended control register index

  @return                 The current value of the extended control register
**/
UINT64
EFIAPI
AsmXGetBv (
  IN UINT32  Index
  );

/**
  Executes a XSETBV instruction to write a 64-bit value to a Extended Control
  Register(XCR), and returns the value.

  Writes the 64-bit value specified by Value to the XCR specified by Index. The
  64-bit value written to the XCR is returned. No parameter checking is
  performed on Index or Value, and some of these may cause CPU exceptions. The
  caller must either guarantee that Index and Value are valid, or the caller
  must establish proper exception handlers. This function is only available on
  IA-32 and x64.

  @param  Index The 32-bit XCR index to write.
  @param  Value The 64-bit value to write to the XCR.

  @return Value

**/
UINT64
EFIAPI
AsmXSetBv (
  IN UINT32  Index,
  IN UINT64  Value
  );

/**
  Executes a VMGEXIT instruction (VMMCALL with a REP prefix)

  Executes a VMGEXIT instruction. This function is only available on IA-32 and
  x64.

**/
VOID
EFIAPI
AsmVmgExit (
  VOID
  );

/**
  Patch the immediate operand of an IA32 or X64 instruction such that the byte,
  word, dword or qword operand is encoded at the end of the instruction's

VOID
EFIAPI
PatchInstructionX86 (
  OUT X86_ASSEMBLY_PATCH_LABEL  *InstructionEnd,
  IN  UINT64                    PatchValue,
  IN  UINTN                     ValueSize
  );

#endif // defined (MDE_CPU_IA32) || defined (MDE_CPU_X64)




//
// Declare bits for PcdDebugPrintErrorLevel and the ErrorLevel parameter of DebugPrint()
//
#define DEBUG_INIT      0x00000001       // Initialization
#define DEBUG_WARN      0x00000002       // Warnings
#define DEBUG_LOAD      0x00000004       // Load events
#define DEBUG_FS        0x00000008       // EFI File system
#define DEBUG_POOL      0x00000010       // Alloc & Free (pool)
#define DEBUG_PAGE      0x00000020       // Alloc & Free (page)
#define DEBUG_INFO      0x00000040       // Informational debug messages
#define DEBUG_DISPATCH  0x00000080       // PEI/DXE/SMM Dispatchers
#define DEBUG_VARIABLE  0x00000100       // Variable
#define DEBUG_BM        0x00000400       // Boot Manager
#define DEBUG_BLKIO     0x00001000       // BlkIo Driver
#define DEBUG_NET       0x00004000       // Network Io Driver
#define DEBUG_UNDI      0x00010000       // UNDI Driver
#define DEBUG_LOADFILE  0x00020000       // LoadFile
#define DEBUG_EVENT     0x00080000       // Event messages
#define DEBUG_GCD       0x00100000       // Global Coherency Database changes
#define DEBUG_CACHE     0x00200000       // Memory range cachability changes
#define DEBUG_VERBOSE   0x00400000       // Detailed debug messages that may
                                         // significantly impact boot performance
#define DEBUG_MANAGEABILITY  0x00800000  // Detailed debug and payload manageability messages
                                         // related to modules such as Redfish, IPMI, MCTP etc.
#define DEBUG_ERROR  0x80000000          // Error

//
// Aliases of debug message mask bits

#define EFI_D_VERBOSE   DEBUG_VERBOSE
#define EFI_D_ERROR     DEBUG_ERROR

//
// Source file line number.
// Default is use the to compiler provided __LINE__ macro value. The __LINE__
// mapping can be overriden by predefining DEBUG_LINE_NUMBER
//
// Defining DEBUG_LINE_NUMBER to a fixed value is useful when comparing builds
// across source code formatting changes that may add/remove lines in a source
// file.
//
#ifdef DEBUG_LINE_NUMBER
#else
#define DEBUG_LINE_NUMBER  __LINE__
#endif

/**
  Macro that converts a Boolean expression to a Null-terminated ASCII string.

  The default is to use the C pre-processor stringizing operator '#' to add
  quotes around the C expression. If DEBUG_EXPRESSION_STRING_VALUE is defined
  then the C expression is converted to the fixed string value.

  Defining DEBUG_EXPRESSION_STRING_VALUE to a fixed value is useful when
  comparing builds across source code formatting changes that may make
  changes to spaces or parenthesis in a Boolean expression.

  @param  Expression  Boolean expression.

**/

#ifdef DEBUG_EXPRESSION_STRING_VALUE
#define DEBUG_EXPRESSION_STRING(Expression)  DEBUG_EXPRESSION_STRING_VALUE
#else
#define DEBUG_EXPRESSION_STRING(Expression)  #Expression
#endif

/**
  Prints a debug message to the debug output device if the specified error level is enabled.


  ...
  );


/**
  Prints a debug message to the debug output device if the specified
  error level is enabled.

VOID
EFIAPI
DebugVPrint (
  IN  UINTN        ErrorLevel,
  IN  CONST CHAR8  *Format,
  IN  VA_LIST      VaListMarker
  );


/**
  Prints a debug message to the debug output device if the specified
  error level is enabled.

VOID
EFIAPI
DebugBPrint (
  IN  UINTN        ErrorLevel,
  IN  CONST CHAR8  *Format,
  IN  BASE_LIST    BaseListMarker
  );


/**
  Prints an assert message containing a filename, line number, and description.
  This may be followed by a breakpoint or a dead loop.

  IN CONST CHAR8  *Description
  );


/**
  Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.


  IN UINTN  Length
  );


/**
  Returns TRUE if ASSERT() macros are enabled.


  VOID
  );


/**
  Returns TRUE if DEBUG() macros are enabled.


  VOID
  );


/**
  Returns TRUE if DEBUG_CODE() macros are enabled.


  VOID
  );


/**
  Returns TRUE if DEBUG_CLEAR_MEMORY() macro is enabled.


BOOLEAN
EFIAPI
DebugPrintLevelEnabled (
  IN  CONST UINTN  ErrorLevel
  );

/**

  @param  Expression  Boolean expression that evaluated to FALSE

**/
#if defined (EDKII_UNIT_TEST_FRAMEWORK_ENABLED)

/**
  Unit test library replacement for DebugAssert() in DebugLib.

  If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed.
  If Description is NULL, then a <Description> string of "(NULL) Description" is printed.

  @param  FileName     The pointer to the name of the source file that generated the assert condition.
  @param  LineNumber   The line number in the source file that generated the assert condition
  @param  Description  The pointer to the description of the assert condition.

**/
VOID
EFIAPI
UnitTestDebugAssert (
  IN CONST CHAR8  *FileName,
  IN UINTN        LineNumber,
  IN CONST CHAR8  *Description
  );

  #if defined (_ASSERT)
    #undef _ASSERT
  #endif
  #if defined (__clang__) && defined (__FILE_NAME__)
#define _ASSERT(Expression)  UnitTestDebugAssert (__FILE_NAME__, DEBUG_LINE_NUMBER, DEBUG_EXPRESSION_STRING (Expression))
  #else
#define _ASSERT(Expression)  UnitTestDebugAssert (__FILE__, DEBUG_LINE_NUMBER, DEBUG_EXPRESSION_STRING (Expression))
  #endif
#else
  #if defined (__clang__) && defined (__FILE_NAME__)
#define _ASSERT(Expression)  DebugAssert (__FILE_NAME__, DEBUG_LINE_NUMBER, DEBUG_EXPRESSION_STRING (Expression))
  #else
#define _ASSERT(Expression)  DebugAssert (__FILE__, DEBUG_LINE_NUMBER, DEBUG_EXPRESSION_STRING (Expression))
  #endif
#endif


/**
  Internal worker macro that calls DebugPrint().



**/

#if !defined (MDE_CPU_EBC) && (!defined (_MSC_VER) || _MSC_VER > 1400)
#define _DEBUG_PRINT(PrintLevel, ...)              \
    do {                                             \
      if (DebugPrintLevelEnabled (PrintLevel)) {     \
        DebugPrint (PrintLevel, ##__VA_ARGS__);      \
      }                                              \
    } while (FALSE)
#define _DEBUGLIB_DEBUG(Expression)  _DEBUG_PRINT Expression
#else
#define _DEBUGLIB_DEBUG(Expression)  DebugPrint Expression
#endif

/**

  @param  Expression  Boolean expression.

**/
#if !defined (MDEPKG_NDEBUG)
#define ASSERT(Expression)        \
    do {                            \
      if (DebugAssertEnabled ()) {  \
        if (!(Expression)) {        \

      }                             \
    } while (FALSE)
#else
#define ASSERT(Expression)
#endif

/**



**/
#if !defined (MDEPKG_NDEBUG)
#define DEBUG(Expression)        \
    do {                           \
      if (DebugPrintEnabled ()) {  \
        _DEBUGLIB_DEBUG (Expression);       \
      }                            \
    } while (FALSE)
#else
#define DEBUG(Expression)
#endif

/**

  @param  StatusParameter  EFI_STATUS value to evaluate.

**/
#if !defined (MDEPKG_NDEBUG)
#define ASSERT_EFI_ERROR(StatusParameter)                                              \
    do {                                                                                 \
      if (DebugAssertEnabled ()) {                                                       \
        if (EFI_ERROR (StatusParameter)) {                                               \
          DEBUG ((DEBUG_ERROR, "\nASSERT_EFI_ERROR (Status = %r)\n", StatusParameter));  \
          _ASSERT (!EFI_ERROR (StatusParameter));                                        \
        }                                                                                \
      }                                                                                  \
    } while (FALSE)
#else
#define ASSERT_EFI_ERROR(StatusParameter)
#endif

/**

  @param  StatusParameter  RETURN_STATUS value to evaluate.

**/
#if !defined (MDEPKG_NDEBUG)
#define ASSERT_RETURN_ERROR(StatusParameter)                          \
    do {                                                                \
      if (DebugAssertEnabled ()) {                                      \
        if (RETURN_ERROR (StatusParameter)) {                           \

      }                                                                 \
    } while (FALSE)
#else
#define ASSERT_RETURN_ERROR(StatusParameter)
#endif

/**

  @param  Guid    The pointer to a protocol GUID.

**/
#if !defined (MDEPKG_NDEBUG)
#define ASSERT_PROTOCOL_ALREADY_INSTALLED(Handle, Guid)                               \
    do {                                                                                \
      if (DebugAssertEnabled ()) {                                                      \
        VOID  *Instance;                                                                \

      }                                                                                 \
    } while (FALSE)
#else
#define ASSERT_PROTOCOL_ALREADY_INSTALLED(Handle, Guid)
#endif

/**

**/
#define DEBUG_CODE_BEGIN()  do { if (DebugCodeEnabled ()) { UINT8  __DebugCodeLocal


/**
  The macro that marks the end of debug source code.


  are not included in a module.

**/
#define DEBUG_CODE_END()  __DebugCodeLocal = 0; __DebugCodeLocal++; } } while (FALSE)


/**
  The macro that declares a section of debug source code.

  Expression                    \
  DEBUG_CODE_END ()


/**
  The macro that calls DebugClearMemory() to clear a buffer to a default value.


    }                                        \
  } while (FALSE)


/**
  Macro that calls DebugAssert() if the containing record does not have a
  matching signature.  If the signatures matches, then a pointer to the data

  @param  TestSignature  The 32-bit signature value to match.

**/
#if !defined (MDEPKG_NDEBUG)
#define CR(Record, TYPE, Field, TestSignature)                                              \
    (DebugAssertEnabled () && (BASE_CR (Record, TYPE, Field)->Signature != TestSignature)) ?  \
    (TYPE *) (_ASSERT (CR has Bad Signature), Record) :                                       \
    BASE_CR (Record, TYPE, Field)
#else
#define CR(Record, TYPE, Field, TestSignature)                                              \
    BASE_CR (Record, TYPE, Field)
#endif





#ifndef __DEVICE_PATH_LIB_H__
#define __DEVICE_PATH_LIB_H__

#define END_DEVICE_PATH_LENGTH  (sizeof (EFI_DEVICE_PATH_PROTOCOL))

/**
  Determine whether a given device path is valid.

BOOLEAN
EFIAPI
IsDevicePathValid (
  IN CONST EFI_DEVICE_PATH_PROTOCOL  *DevicePath,
  IN       UINTN                     MaxSize
  );

/**

EFI_DEVICE_PATH_PROTOCOL *
EFIAPI
AppendDevicePath (
  IN CONST EFI_DEVICE_PATH_PROTOCOL  *FirstDevicePath   OPTIONAL,
  IN CONST EFI_DEVICE_PATH_PROTOCOL  *SecondDevicePath  OPTIONAL
  );


EFI_DEVICE_PATH_PROTOCOL *
EFIAPI
AppendDevicePathNode (
  IN CONST EFI_DEVICE_PATH_PROTOCOL  *DevicePath      OPTIONAL,
  IN CONST EFI_DEVICE_PATH_PROTOCOL  *DevicePathNode  OPTIONAL
  );


EFI_DEVICE_PATH_PROTOCOL *
EFIAPI
AppendDevicePathInstance (
  IN CONST EFI_DEVICE_PATH_PROTOCOL  *DevicePath         OPTIONAL,
  IN CONST EFI_DEVICE_PATH_PROTOCOL  *DevicePathInstance OPTIONAL
  );


EFI_DEVICE_PATH_PROTOCOL *
EFIAPI
GetNextDevicePathInstance (
  IN OUT EFI_DEVICE_PATH_PROTOCOL  **DevicePath,
  OUT UINTN                        *Size
  );

/**

EFI_DEVICE_PATH_PROTOCOL *
EFIAPI
CreateDeviceNode (
  IN UINT8   NodeType,
  IN UINT8   NodeSubType,
  IN UINT16  NodeLength
  );

/**

EFI_DEVICE_PATH_PROTOCOL *
EFIAPI
DevicePathFromHandle (
  IN EFI_HANDLE  Handle
  );

/**

EFI_DEVICE_PATH_PROTOCOL *
EFIAPI
FileDevicePath (
  IN EFI_HANDLE    Device      OPTIONAL,
  IN CONST CHAR16  *FileName
  );

/**

CHAR16 *
EFIAPI
ConvertDevicePathToText (
  IN CONST EFI_DEVICE_PATH_PROTOCOL  *DevicePath,
  IN BOOLEAN                         DisplayOnly,
  IN BOOLEAN                         AllowShortcuts
  );

/**

EFI_DEVICE_PATH_PROTOCOL *
EFIAPI
ConvertTextToDeviceNode (
  IN CONST CHAR16  *TextDeviceNode
  );

/**

EFI_DEVICE_PATH_PROTOCOL *
EFIAPI
ConvertTextToDevicePath (
  IN CONST CHAR16  *TextDevicePath
  );

#endif

Lines 481-487 ReallocateReservedPool ( Link Here

(-)b/sys/contrib/edk2/Include/Library/MemoryAllocationLib.h (-1 / +1 lines)
481	VOID	481	VOID
482	EFIAPI	482	EFIAPI
483	FreePool (	483	FreePool (
484	IN VOID *Buffer	484	IN VOID *Buffer
485	);	485	);
486		486
487	#endif	487	#endif




#ifndef __PCD_LIB_H__
#define __PCD_LIB_H__


/**
  Retrieves a token number based on a token name.


  @return  The token number associated with the PCD.

**/
#define PcdToken(TokenName)  _PCD_TOKEN_##TokenName


/**
  Retrieves a Boolean PCD feature flag based on a token name.

  @return  Boolean value for the PCD feature flag.

**/
#define FeaturePcdGet(TokenName)  _PCD_GET_MODE_BOOL_##TokenName


/**
  Retrieves an 8-bit fixed PCD token value based on a token name.

  @return  8-bit value for the token specified by TokenName.

**/
#define FixedPcdGet8(TokenName)  _PCD_VALUE_##TokenName


/**
  Retrieves a 16-bit fixed PCD token value based on a token name.

  @return  16-bit value for the token specified by TokenName.

**/
#define FixedPcdGet16(TokenName)  _PCD_VALUE_##TokenName


/**
  Retrieves a 32-bit fixed PCD token value based on a token name.

  @return  32-bit value for the token specified by TokenName.

**/
#define FixedPcdGet32(TokenName)  _PCD_VALUE_##TokenName


/**
  Retrieves a 64-bit fixed PCD token value based on a token name.

  @return  64-bit value for the token specified by TokenName.

**/
#define FixedPcdGet64(TokenName)  _PCD_VALUE_##TokenName


/**
  Retrieves a Boolean fixed PCD token value based on a token name.

  @return  The Boolean value for the token.

**/
#define FixedPcdGetBool(TokenName)  _PCD_VALUE_##TokenName


/**
  Retrieves a pointer to a fixed PCD token buffer based on a token name.

  @return  A pointer to the buffer.

**/
#define FixedPcdGetPtr(TokenName)  ((VOID *)_PCD_VALUE_##TokenName)


/**
  Retrieves an 8-bit binary patchable PCD token value based on a token name.

  @return  An 8-bit binary patchable PCD token value.

**/
#define PatchPcdGet8(TokenName)  _gPcd_BinaryPatch_##TokenName

/**
  Retrieves a 16-bit binary patchable PCD token value based on a token name.

  @return  A 16-bit binary patchable PCD token value.

**/
#define PatchPcdGet16(TokenName)  _gPcd_BinaryPatch_##TokenName


/**
  Retrieves a 32-bit binary patchable PCD token value based on a token name.

  @return  A 32-bit binary patchable PCD token value.

**/
#define PatchPcdGet32(TokenName)  _gPcd_BinaryPatch_##TokenName


/**
  Retrieves a 64-bit binary patchable PCD token value based on a token name.

  @return  A 64-bit binary patchable PCD token value.

**/
#define PatchPcdGet64(TokenName)  _gPcd_BinaryPatch_##TokenName


/**
  Retrieves a Boolean binary patchable PCD token value based on a token name.

  @return  The Boolean value for the token.

**/
#define PatchPcdGetBool(TokenName)  _gPcd_BinaryPatch_##TokenName


/**
  Retrieves a pointer to a binary patchable PCD token buffer based on a token name.

  @return  A pointer to the buffer for the token.

**/
#define PatchPcdGetPtr(TokenName)  ((VOID *)_gPcd_BinaryPatch_##TokenName)


/**
  Sets an 8-bit binary patchable PCD token value based on a token name.

  @return Return the Value that was set.

**/
#define PatchPcdSet8(TokenName, Value)  (_gPcd_BinaryPatch_##TokenName = (Value))


/**
  Sets a 16-bit binary patchable PCD token value based on a token name.

  @return Return the Value that was set.

**/
#define PatchPcdSet16(TokenName, Value)  (_gPcd_BinaryPatch_##TokenName = (Value))


/**
  Sets a 32-bit binary patchable PCD token value based on a token name.

  @return Return the Value that was set.

**/
#define PatchPcdSet32(TokenName, Value)  (_gPcd_BinaryPatch_##TokenName = (Value))


/**
  Sets a 64-bit binary patchable PCD token value based on a token name.

  @return Return the Value that was set.

**/
#define PatchPcdSet64(TokenName, Value)  (_gPcd_BinaryPatch_##TokenName = (Value))


/**
  Sets a Boolean binary patchable PCD token value based on a token name.

  @return Return the Value that was set.

**/
#define PatchPcdSetBool(TokenName, Value)  (_gPcd_BinaryPatch_##TokenName = (Value))


/**
  Sets a pointer to a binary patchable PCD token buffer based on a token name.

                                              (Size),                                  \
                                              (Buffer)                                 \
                                              )

/**
  Retrieves an 8-bit PCD token value based on a token name.


  @return  8-bit value for the token specified by TokenName.

**/
#define PcdGet8(TokenName)  _PCD_GET_MODE_8_##TokenName


/**
  Retrieves a 16-bit PCD token value based on a token name.

  @return  16-bit value for the token specified by TokenName.

**/
#define PcdGet16(TokenName)  _PCD_GET_MODE_16_##TokenName


/**
  Retrieves a 32-bit PCD token value based on a token name.

  @return  32-bit value for the token specified by TokenName.

**/
#define PcdGet32(TokenName)  _PCD_GET_MODE_32_##TokenName


/**
  Retrieves a 64-bit PCD token value based on a token name.

  @return  64-bit value for the token specified by TokenName.

**/
#define PcdGet64(TokenName)  _PCD_GET_MODE_64_##TokenName


/**
  Retrieves a pointer to a PCD token buffer based on a token name.

  @return  A pointer to the buffer.

**/
#define PcdGetPtr(TokenName)  _PCD_GET_MODE_PTR_##TokenName


/**
  Retrieves a Boolean PCD token value based on a token name.

  @return  A Boolean PCD token value.

**/
#define PcdGetBool(TokenName)  _PCD_GET_MODE_BOOL_##TokenName


/**
  Retrieves the size of a fixed PCD token based on a token name.

  @return     Return the size

**/
#define FixedPcdGetSize(TokenName)  _PCD_SIZE_##TokenName


/**
  Retrieves the size of a binary patchable PCD token based on a token name.

  @return     Return the size

**/
#define PatchPcdGetSize(TokenName)  _gPcd_BinaryPatch_Size_##TokenName


/**
  Retrieves the size of the PCD token based on a token name.

  @return      Return the size

**/
#define PcdGetSize(TokenName)  _PCD_GET_MODE_SIZE_##TokenName


/**
  Retrieve the size of a given PCD token.

  @return     Return the size.

**/
#define PcdGetExSize(Guid, TokenName)  LibPcdGetExSize ((Guid), PcdTokenEx(Guid,TokenName))

#ifndef DISABLE_NEW_DEPRECATED_INTERFACES
/**
  Sets an 8-bit PCD token value based on a token name.

  Sets the 8-bit value for the token specified by TokenName. Value is returned.
  If TokenName is not a valid token in the token space, then the module will not build.

  @param   TokenName  The name of the PCD token to retrieve a current value for.
  @param   Value      The 8-bit value to set.

  @return Return the Value that was set.

**/
#define PcdSet8(TokenName, Value)           _PCD_SET_MODE_8_##TokenName     ((Value))


/**
  Sets a 16-bit PCD token value based on a token name.

  Sets the 16-bit value for the token specified by TokenName. Value is returned.
  If TokenName is not a valid token in the token space, then the module will not build.

  @param   TokenName  The name of the PCD token to retrieve a current value for.
  @param   Value      The 16-bit value to set.

  @return Return the Value that was set.

**/
#define PcdSet16(TokenName, Value)          _PCD_SET_MODE_16_##TokenName    ((Value))


/**
  Sets a 32-bit PCD token value based on a token name.

  Sets the 32-bit value for the token specified by TokenName. Value is returned.
  If TokenName is not a valid token in the token space, then the module will not build.

  @param   TokenName  The name of the PCD token to retrieve a current value for.
  @param   Value      The 32-bit value to set.

  @return Return the Value that was set.

**/
#define PcdSet32(TokenName, Value)          _PCD_SET_MODE_32_##TokenName    ((Value))


/**
  Sets a 64-bit PCD token value based on a token name.

  Sets the 64-bit value for the token specified by TokenName. Value is returned.
  If TokenName is not a valid token in the token space, then the module will not build.

  @param   TokenName  The name of the PCD token to retrieve a current value for.
  @param   Value      The 64-bit value to set.

  @return Return the Value that was set.

**/
#define PcdSet64(TokenName, Value)          _PCD_SET_MODE_64_##TokenName    ((Value))


/**
  Sets a pointer to a PCD token buffer based on a token name.

  Sets the buffer for the token specified by TokenName. Buffer is returned.
  If SizeOfBuffer is greater than the maximum size supported by TokenName,
  then set SizeOfBuffer to the maximum size supported by TokenName and return NULL
  to indicate that the set operation was not actually performed.  If SizeOfBuffer
  is set to MAX_ADDRESS, then SizeOfBuffer must be set to the maximum size supported
  by TokenName and NULL must be returned.
  If TokenName is not a valid token in the token space, then the module will not build.

  If SizeOfBuffer is NULL, then ASSERT().
  If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().

  @param   TokenName      The name of the PCD token to set the current value for.
  @param   SizeOfBuffer   A pointer to the size, in bytes, of Buffer.
  @param   Buffer         A pointer to the buffer to set.

  @return Return the pointer to the Buffer that was set.

**/
#define PcdSetPtr(TokenName, SizeOfBuffer, Buffer) \
                                            _PCD_SET_MODE_PTR_##TokenName   ((SizeOfBuffer), (Buffer))

/**
  Sets a Boolean PCD token value based on a token name.

  Sets the Boolean value for the token specified by TokenName. Value is returned.
  If TokenName is not a valid token in the token space, then the module will not build.

  @param   TokenName      The name of the PCD token to set the current value for.
  @param   Buffer         The Boolean value to set.

  @return Return the Value that was set.

**/
#define PcdSetBool(TokenName, Value)        _PCD_SET_MODE_BOOL_##TokenName  ((Value))
#endif

/**
  Sets a 8-bit PCD token value based on a token name.

  @return The status of the set operation.

**/
#define PcdSet8S(TokenName, Value)  _PCD_SET_MODE_8_S_##TokenName    ((Value))

/**
  Sets a 16-bit PCD token value based on a token name.

  @return The status of the set operation.

**/
#define PcdSet16S(TokenName, Value)  _PCD_SET_MODE_16_S_##TokenName    ((Value))

/**
  Sets a 32-bit PCD token value based on a token name.

  @return The status of the set operation.

**/
#define PcdSet32S(TokenName, Value)  _PCD_SET_MODE_32_S_##TokenName    ((Value))

/**
  Sets a 64-bit PCD token value based on a token name.

  @return The status of the set operation.

**/
#define PcdSet64S(TokenName, Value)  _PCD_SET_MODE_64_S_##TokenName    ((Value))

/**
  Sets a pointer to a PCD token buffer based on a token name.

#define PcdSetPtrS(TokenName, SizeOfBuffer, Buffer) \
                                            _PCD_SET_MODE_PTR_S_##TokenName   ((SizeOfBuffer), (Buffer))



/**
  Sets a boolean PCD token value based on a token name.


  @return The status of the set operation.

**/
#define PcdSetBoolS(TokenName, Value)  _PCD_SET_MODE_BOOL_S_##TokenName    ((Value))

/**
  Retrieves a token number based on a GUID and a token name.

  @return  Return the token number.

**/
#define PcdTokenEx(Guid, TokenName)  _PCD_TOKEN_EX_##TokenName(Guid)

/**
  Retrieves an 8-bit PCD token value based on a GUID and a token name.

  @return  An 8-bit PCD token value.

**/
#define PcdGetEx8(Guid, TokenName)  LibPcdGetEx8 ((Guid), PcdTokenEx(Guid,TokenName))

/**
  Retrieves a 16-bit PCD token value based on a GUID and a token name.

  @return  A 16-bit PCD token value.

**/
#define PcdGetEx16(Guid, TokenName)  LibPcdGetEx16 ((Guid), PcdTokenEx(Guid,TokenName))


/**
  Retrieves a 32-bit PCD token value based on a GUID and a token name.

  @return  A 32-bit PCD token value.

**/
#define PcdGetEx32(Guid, TokenName)  LibPcdGetEx32 ((Guid), PcdTokenEx(Guid,TokenName))


/**
  Retrieves a 64-bit PCD token value based on a GUID and a token name.

  @return  A 64-bit PCD token value.

**/
#define PcdGetEx64(Guid, TokenName)  LibPcdGetEx64 ((Guid), PcdTokenEx(Guid,TokenName))


/**
  Retrieves a pointer to a PCD token buffer based on a GUID and a token name.

  @return  A pointer to a PCD token buffer.

**/
#define PcdGetExPtr(Guid, TokenName)  LibPcdGetExPtr ((Guid), PcdTokenEx(Guid,TokenName))


/**
  Retrieves a Boolean PCD token value based on a GUID and a token name.

  @return  A Boolean PCD token value.

**/
#define PcdGetExBool(Guid, TokenName)  LibPcdGetExBool  ((Guid), PcdTokenEx(Guid,TokenName))



#ifndef DISABLE_NEW_DEPRECATED_INTERFACES
/**
  Sets an 8-bit PCD token value based on a GUID and a token name.

  Sets the 8-bit value for the token specified by Guid and TokenName. Value is returned.
  If TokenName is not a valid token in the token space specified by Guid,
  then the module will not build.

  If Guid is NULL, then ASSERT().

  @param   Guid        Pointer to a 128-bit unique value that designates
                       which namespace to retrieve a value from.
  @param   TokenName   The name of the PCD token to set the current value for.
  @param   Value       The 8-bit value to set.

  @return Return the Value that was set.

**/
#define PcdSetEx8(Guid, TokenName, Value)   LibPcdSetEx8   ((Guid), PcdTokenEx(Guid,TokenName), (Value))


/**
  Sets a 16-bit PCD token value based on a GUID and a token name.

  Sets the 16-bit value for the token specified by Guid and TokenName. Value is returned.
  If TokenName is not a valid token in the token space specified by Guid,
  then the module will not build.

  If Guid is NULL, then ASSERT().

  @param   Guid        Pointer to a 128-bit unique value that designates
                       which namespace to retrieve a value from.
  @param   TokenName   The name of the PCD token to set the current value for.
  @param   Value       The 16-bit value to set.

  @return Return the Value that was set.

**/
#define PcdSetEx16(Guid, TokenName, Value)  LibPcdSetEx16  ((Guid), PcdTokenEx(Guid,TokenName), (Value))


/**
  Sets a 32-bit PCD token value based on a GUID and a token name.

  Sets the 32-bit value for the token specified by Guid and TokenName. Value is returned.
  If TokenName is not a valid token in the token space specified by Guid,
  then the module will not build.

  If Guid is NULL, then ASSERT().

  @param   Guid        Pointer to a 128-bit unique value that designates
                       which namespace to retrieve a value from.
  @param   TokenName   The name of the PCD token to set the current value for.
  @param   Value       The 32-bit value to set.

  @return Return the Value that was set.

**/
#define PcdSetEx32(Guid, TokenName, Value)  LibPcdSetEx32  ((Guid), PcdTokenEx(Guid,TokenName), (Value))


/**
  Sets a 64-bit PCD token value based on a GUID and a token name.

  Sets the 64-bit value for the token specified by Guid and TokenName. Value is returned.
  If TokenName is not a valid token in the token space specified by Guid,
  then the module will not build.

  If Guid is NULL, then ASSERT().

  @param   Guid        Pointer to a 128-bit unique value that designates
  which namespace to retrieve a value from.
  @param   TokenName   The name of the PCD token to set the current value for.
  @param   Value       The 64-bit value to set.

  @return Return the Value that was set.

**/
#define PcdSetEx64(Guid, TokenName, Value)  LibPcdSetEx64  ((Guid), PcdTokenEx(Guid,TokenName), (Value))


/**
  Sets a pointer to a PCD token buffer based on a GUID and a token name.

  Sets the buffer for the token specified by Guid and TokenName. Buffer is returned.
  If SizeOfBuffer is greater than the maximum size supported by Guid and TokenName,
  then set SizeOfBuffer to the maximum size supported by Guid and TokenName and return
  NULL to indicate that the set operation was not actually performed. If SizeOfBuffer
  is set to MAX_ADDRESS, then SizeOfBuffer must be set to the maximum size supported by
  Guid and TokenName and NULL must be returned.
  If TokenName is not a valid token in the token space specified by Guid,
  then the module will not build.

  If Guid is NULL, then ASSERT().
  If SizeOfBuffer is NULL, then ASSERT().
  If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().

  @param   Guid           Pointer to a 128-bit unique value that designates
                          which namespace to retrieve a value from.
  @param   TokenName      The name of the PCD token to set the current value for.
  @param   SizeOfBuffer   A pointer to the size, in bytes, of Buffer.
  @param   Buffer         Pointer to the buffer to set.

  @return Return the pointer to the Buffer that was set.

**/
#define PcdSetExPtr(Guid, TokenName, SizeOfBuffer, Buffer) \
                                            LibPcdSetExPtr ((Guid), PcdTokenEx(Guid,TokenName), (SizeOfBuffer), (Buffer))


/**
  Sets a Boolean PCD token value based on a GUID and a token name.

  Sets the Boolean value for the token specified by Guid and TokenName. Value is returned.
  If TokenName is not a valid token in the token space specified by Guid,
  then the module will not build.

  If Guid is NULL, then ASSERT().

  @param   Guid           Pointer to a 128-bit unique value that designates
                          which namespace to retrieve a value from.
  @param   TokenName      The name of the PCD token to set the current value for.
  @param   Value          The Boolean value to set.

  @return Return the Value that was set.

**/
#define PcdSetExBool(Guid, TokenName, Value) \
                                            LibPcdSetExBool((Guid), PcdTokenEx(Guid,TokenName), (Value))
#endif

/**
  Sets an 8-bit PCD token value based on a GUID and a token name.

  @return The status of the set operation.

**/
#define PcdSetEx8S(Guid, TokenName, Value)  LibPcdSetEx8S ((Guid), PcdTokenEx(Guid,TokenName), (Value))

/**
  Sets an 16-bit PCD token value based on a GUID and a token name.

  @return The status of the set operation.

**/
#define PcdSetEx16S(Guid, TokenName, Value)  LibPcdSetEx16S ((Guid), PcdTokenEx(Guid,TokenName), (Value))

/**
  Sets an 32-bit PCD token value based on a GUID and a token name.

  @return The status of the set operation.

**/
#define PcdSetEx32S(Guid, TokenName, Value)  LibPcdSetEx32S ((Guid), PcdTokenEx(Guid,TokenName), (Value))

/**
  Sets an 64-bit PCD token value based on a GUID and a token name.

  @return The status of the set operation.

**/
#define PcdSetEx64S(Guid, TokenName, Value)  LibPcdSetEx64S ((Guid), PcdTokenEx(Guid,TokenName), (Value))

/**
  Sets a pointer to a PCD token buffer based on a GUID and a token name.

#define PcdSetExPtrS(Guid, TokenName, SizeOfBuffer, Buffer) \
                                            LibPcdSetExPtrS ((Guid), PcdTokenEx(Guid,TokenName), (SizeOfBuffer), (Buffer))


/**
  Sets an boolean PCD token value based on a GUID and a token name.


UINTN
EFIAPI
LibPcdSetSku (
  IN UINTN  SkuId
  );


/**
  This function provides a means by which to retrieve a value for a given PCD token.


UINT8
EFIAPI
LibPcdGet8 (
  IN UINTN  TokenNumber
  );


/**
  This function provides a means by which to retrieve a value for a given PCD token.


UINT16
EFIAPI
LibPcdGet16 (
  IN UINTN  TokenNumber
  );


/**
  This function provides a means by which to retrieve a value for a given PCD token.


UINT32
EFIAPI
LibPcdGet32 (
  IN UINTN  TokenNumber
  );


/**
  This function provides a means by which to retrieve a value for a given PCD token.


UINT64
EFIAPI
LibPcdGet64 (
  IN UINTN  TokenNumber
  );


/**
  This function provides a means by which to retrieve a value for a given PCD token.


VOID *
EFIAPI
LibPcdGetPtr (
  IN UINTN  TokenNumber
  );


/**
  This function provides a means by which to retrieve a value for a given PCD token.


BOOLEAN
EFIAPI
LibPcdGetBool (
  IN UINTN  TokenNumber
  );


/**
  This function provides a means by which to retrieve the size of a given PCD token.


UINTN
EFIAPI
LibPcdGetSize (
  IN UINTN  TokenNumber
  );


/**
  This function provides a means by which to retrieve a value for a given PCD token.


UINT8
EFIAPI
LibPcdGetEx8 (
  IN CONST GUID  *Guid,
  IN UINTN       TokenNumber
  );


/**
  This function provides a means by which to retrieve a value for a given PCD token.


UINT16
EFIAPI
LibPcdGetEx16 (
  IN CONST GUID  *Guid,
  IN UINTN       TokenNumber
  );


/**
  Returns the 32-bit value for the token specified by TokenNumber and Guid.
  If Guid is NULL, then ASSERT().

UINT32
EFIAPI
LibPcdGetEx32 (
  IN CONST GUID  *Guid,
  IN UINTN       TokenNumber
  );


/**
  This function provides a means by which to retrieve a value for a given PCD token.


UINT64
EFIAPI
LibPcdGetEx64 (
  IN CONST GUID  *Guid,
  IN UINTN       TokenNumber
  );


/**
  This function provides a means by which to retrieve a value for a given PCD token.


VOID *
EFIAPI
LibPcdGetExPtr (
  IN CONST GUID  *Guid,
  IN UINTN       TokenNumber
  );


/**
  This function provides a means by which to retrieve a value for a given PCD token.


BOOLEAN
EFIAPI
LibPcdGetExBool (
  IN CONST GUID  *Guid,
  IN UINTN       TokenNumber
  );


/**
  This function provides a means by which to retrieve the size of a given PCD token.


UINTN
EFIAPI
LibPcdGetExSize (
  IN CONST GUID  *Guid,
  IN UINTN       TokenNumber
  );


#ifndef DISABLE_NEW_DEPRECATED_INTERFACES
/**
  This function provides a means by which to set a value for a given PCD token.

  Sets the 8-bit value for the token specified by TokenNumber
  to the value specified by Value.  Value is returned.

  @param[in]  TokenNumber   The PCD token number to set a current value for.
  @param[in]  Value         The 8-bit value to set.

  @return Return the Value that was set.

**/
UINT8
EFIAPI
LibPcdSet8 (
  IN UINTN             TokenNumber,
  IN UINT8             Value
  );


/**
  This function provides a means by which to set a value for a given PCD token.

  Sets the 16-bit value for the token specified by TokenNumber
  to the value specified by Value.  Value is returned.

  @param[in]  TokenNumber   The PCD token number to set a current value for.
  @param[in]  Value         The 16-bit value to set.

  @return Return the Value that was set.

**/
UINT16
EFIAPI
LibPcdSet16 (
  IN UINTN             TokenNumber,
  IN UINT16            Value
  );


/**
  This function provides a means by which to set a value for a given PCD token.

  Sets the 32-bit value for the token specified by TokenNumber
  to the value specified by Value.  Value is returned.

  @param[in]  TokenNumber   The PCD token number to set a current value for.
  @param[in]  Value         The 32-bit value to set.

  @return Return the Value that was set.

**/
UINT32
EFIAPI
LibPcdSet32 (
  IN UINTN             TokenNumber,
  IN UINT32            Value
  );


/**
  This function provides a means by which to set a value for a given PCD token.

  Sets the 64-bit value for the token specified by TokenNumber
  to the value specified by Value.  Value is returned.

  @param[in]  TokenNumber   The PCD token number to set a current value for.
  @param[in]  Value         The 64-bit value to set.

  @return Return the Value that was set.

**/
UINT64
EFIAPI
LibPcdSet64 (
  IN UINTN             TokenNumber,
  IN UINT64            Value
  );


/**
  This function provides a means by which to set a value for a given PCD token.

  Sets a buffer for the token specified by TokenNumber to the value
  specified by Buffer and SizeOfBuffer.  Buffer is returned.
  If SizeOfBuffer is greater than the maximum size support by TokenNumber,
  then set SizeOfBuffer to the maximum size supported by TokenNumber and
  return NULL to indicate that the set operation was not actually performed.

  If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be set to the
  maximum size supported by TokenName and NULL must be returned.

  If SizeOfBuffer is NULL, then ASSERT().
  If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().

  @param[in]      TokenNumber   The PCD token number to set a current value for.
  @param[in, out] SizeOfBuffer  The size, in bytes, of Buffer.
  @param[in]      Buffer        A pointer to the buffer to set.

  @return Return the pointer for the Buffer that was set.

**/
VOID *
EFIAPI
LibPcdSetPtr (
  IN        UINTN             TokenNumber,
  IN OUT    UINTN             *SizeOfBuffer,
  IN CONST  VOID              *Buffer
  );


/**
  This function provides a means by which to set a value for a given PCD token.

  Sets the Boolean value for the token specified by TokenNumber
  to the value specified by Value.  Value is returned.

  @param[in]  TokenNumber   The PCD token number to set a current value for.
  @param[in]  Value         The boolean value to set.

  @return Return the Value that was set.

**/
BOOLEAN
EFIAPI
LibPcdSetBool (
  IN UINTN             TokenNumber,
  IN BOOLEAN           Value
  );


/**
  This function provides a means by which to set a value for a given PCD token.

  Sets the 8-bit value for the token specified by TokenNumber and
  Guid to the value specified by Value. Value is returned.

  If Guid is NULL, then ASSERT().

  @param[in]  Guid          Pointer to a 128-bit unique value that
                            designates which namespace to set a value from.
  @param[in]  TokenNumber   The PCD token number to set a current value for.
  @param[in]  Value         The 8-bit value to set.

  @return Return the Value that was set.

**/
UINT8
EFIAPI
LibPcdSetEx8 (
  IN CONST GUID        *Guid,
  IN UINTN             TokenNumber,
  IN UINT8             Value
  );


/**
  This function provides a means by which to set a value for a given PCD token.

  Sets the 16-bit value for the token specified by TokenNumber and
  Guid to the value specified by Value. Value is returned.

  If Guid is NULL, then ASSERT().

  @param[in]  Guid          Pointer to a 128-bit unique value that
                            designates which namespace to set a value from.
  @param[in]  TokenNumber   The PCD token number to set a current value for.
  @param[in]  Value         The 16-bit value to set.

  @return Return the Value that was set.

**/
UINT16
EFIAPI
LibPcdSetEx16 (
  IN CONST GUID        *Guid,
  IN UINTN             TokenNumber,
  IN UINT16            Value
  );


/**
  This function provides a means by which to set a value for a given PCD token.

  Sets the 32-bit value for the token specified by TokenNumber and
  Guid to the value specified by Value. Value is returned.

  If Guid is NULL, then ASSERT().

  @param[in]  Guid          Pointer to a 128-bit unique value that
                            designates which namespace to set a value from.
  @param[in]  TokenNumber   The PCD token number to set a current value for.
  @param[in]  Value         The 32-bit value to set.

  @return Return the Value that was set.

**/
UINT32
EFIAPI
LibPcdSetEx32 (
  IN CONST GUID        *Guid,
  IN UINTN             TokenNumber,
  IN UINT32            Value
  );


/**
  This function provides a means by which to set a value for a given PCD token.

  Sets the 64-bit value for the token specified by TokenNumber and
  Guid to the value specified by Value. Value is returned.

  If Guid is NULL, then ASSERT().

  @param[in]  Guid          Pointer to a 128-bit unique value that
                            designates which namespace to set a value from.
  @param[in]  TokenNumber   The PCD token number to set a current value for.
  @param[in]  Value         The 64-bit value to set.

  @return Return the Value that was set.

**/
UINT64
EFIAPI
LibPcdSetEx64 (
  IN CONST GUID        *Guid,
  IN UINTN             TokenNumber,
  IN UINT64            Value
  );


/**
  This function provides a means by which to set a value for a given PCD token.

  Sets a buffer for the token specified by TokenNumber to the value specified by
  Buffer and SizeOfBuffer.  Buffer is returned.  If SizeOfBuffer is greater than
  the maximum size support by TokenNumber, then set SizeOfBuffer to the maximum size
  supported by TokenNumber and return NULL to indicate that the set operation
  was not actually performed.

  If Guid is NULL, then ASSERT().
  If SizeOfBuffer is NULL, then ASSERT().
  If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().

  @param[in]  Guid              Pointer to a 128-bit unique value that
                                designates which namespace to set a value from.
  @param[in]  TokenNumber       The PCD token number to set a current value for.
  @param[in, out] SizeOfBuffer  The size, in bytes, of Buffer.
  @param[in]  Buffer            A pointer to the buffer to set.

  @return Return the pointer to the Buffer that was set.

**/
VOID *
EFIAPI
LibPcdSetExPtr (
  IN      CONST GUID        *Guid,
  IN      UINTN             TokenNumber,
  IN OUT  UINTN             *SizeOfBuffer,
  IN      VOID              *Buffer
  );


/**
  This function provides a means by which to set a value for a given PCD token.

  Sets the Boolean value for the token specified by TokenNumber and
  Guid to the value specified by Value. Value is returned.

  If Guid is NULL, then ASSERT().

  @param[in]  Guid          Pointer to a 128-bit unique value that
                            designates which namespace to set a value from.
  @param[in]  TokenNumber   The PCD token number to set a current value for.
  @param[in]  Value         The Boolean value to set.

  @return Return the Value that was set.

**/
BOOLEAN
EFIAPI
LibPcdSetExBool (
  IN CONST GUID        *Guid,
  IN UINTN             TokenNumber,
  IN BOOLEAN           Value
  );
#endif

/**
  This function provides a means by which to set a value for a given PCD token.


RETURN_STATUS
EFIAPI
LibPcdSet8S (
  IN UINTN  TokenNumber,
  IN UINT8  Value
  );

/**

RETURN_STATUS
EFIAPI
LibPcdSet16S (
  IN UINTN   TokenNumber,
  IN UINT16  Value
  );

/**

RETURN_STATUS
EFIAPI
LibPcdSet32S (
  IN UINTN   TokenNumber,
  IN UINT32  Value
  );

/**

RETURN_STATUS
EFIAPI
LibPcdSet64S (
  IN UINTN   TokenNumber,
  IN UINT64  Value
  );

/**

RETURN_STATUS
EFIAPI
LibPcdSetPtrS (
  IN       UINTN  TokenNumber,
  IN OUT   UINTN  *SizeOfBuffer,
  IN CONST VOID   *Buffer
  );

/**

RETURN_STATUS
EFIAPI
LibPcdSetBoolS (
  IN UINTN    TokenNumber,
  IN BOOLEAN  Value
  );

/**

RETURN_STATUS
EFIAPI
LibPcdSetEx8S (
  IN CONST GUID  *Guid,
  IN UINTN       TokenNumber,
  IN UINT8       Value
  );

/**

RETURN_STATUS
EFIAPI
LibPcdSetEx16S (
  IN CONST GUID  *Guid,
  IN UINTN       TokenNumber,
  IN UINT16      Value
  );

/**

RETURN_STATUS
EFIAPI
LibPcdSetEx32S (
  IN CONST GUID  *Guid,
  IN UINTN       TokenNumber,
  IN UINT32      Value
  );

/**

RETURN_STATUS
EFIAPI
LibPcdSetEx64S (
  IN CONST GUID  *Guid,
  IN UINTN       TokenNumber,
  IN UINT64      Value
  );

/**

RETURN_STATUS
EFIAPI
LibPcdSetExPtrS (
  IN CONST GUID   *Guid,
  IN       UINTN  TokenNumber,
  IN OUT   UINTN  *SizeOfBuffer,
  IN       VOID   *Buffer
  );

/**

RETURN_STATUS
EFIAPI
LibPcdSetExBoolS (
  IN CONST GUID  *Guid,
  IN UINTN       TokenNumber,
  IN BOOLEAN     Value
  );

/**

typedef
VOID
(EFIAPI *PCD_CALLBACK)(
  IN        CONST GUID        *CallBackGuid  OPTIONAL,
  IN        UINTN             CallBackToken,
  IN  OUT   VOID              *TokenData,
  IN        UINTN             TokenDataSize
  );


/**
  Set up a notification function that is called when a specified token is set.


VOID
EFIAPI
LibPcdCallbackOnSet (
  IN CONST GUID    *Guid        OPTIONAL,
  IN UINTN         TokenNumber,
  IN PCD_CALLBACK  NotificationFunction
  );


/**
  Disable a notification function that was established with LibPcdCallbackonSet().


VOID
EFIAPI
LibPcdCancelCallback (
  IN CONST GUID    *Guid        OPTIONAL,
  IN UINTN         TokenNumber,
  IN PCD_CALLBACK  NotificationFunction
  );


/**
  Retrieves the next token in a token space.


UINTN
EFIAPI
LibPcdGetNextToken (
  IN CONST GUID  *Guid        OPTIONAL,
  IN UINTN       TokenNumber
  );



/**
  Used to retrieve the list of available PCD token space GUIDs.


  IN CONST GUID  *TokenSpaceGuid
  );


/**
  Sets a value of a patchable PCD entry that is type pointer.


VOID *
EFIAPI
LibPatchPcdSetPtr (
  OUT        VOID  *PatchVariable,
  IN        UINTN  MaximumDatumSize,
  IN OUT    UINTN  *SizeOfBuffer,
  IN CONST  VOID   *Buffer
  );

/**

RETURN_STATUS
EFIAPI
LibPatchPcdSetPtrS (
  OUT      VOID   *PatchVariable,
  IN       UINTN  MaximumDatumSize,
  IN OUT   UINTN  *SizeOfBuffer,
  IN CONST VOID   *Buffer
  );

/**

VOID *
EFIAPI
LibPatchPcdSetPtrAndSize (
  OUT       VOID   *PatchVariable,
  OUT       UINTN  *SizeOfPatchVariable,
  IN        UINTN  MaximumDatumSize,
  IN OUT    UINTN  *SizeOfBuffer,
  IN CONST  VOID   *Buffer
  );

/**

RETURN_STATUS
EFIAPI
LibPatchPcdSetPtrAndSizeS (
  OUT      VOID   *PatchVariable,
  OUT      UINTN  *SizeOfPatchVariable,
  IN       UINTN  MaximumDatumSize,
  IN OUT   UINTN  *SizeOfBuffer,
  IN CONST VOID   *Buffer
  );

typedef enum {

  /// The returned information associated with the requested TokenNumber. If
  /// TokenNumber is 0, then PcdType is set to PCD_TYPE_8.
  ///
  PCD_TYPE    PcdType;
  ///
  /// The size of the data in bytes associated with the TokenNumber specified. If
  /// TokenNumber is 0, then PcdSize is set 0.
  ///
  UINTN       PcdSize;
  ///
  /// The null-terminated ASCII string associated with a given token. If the
  /// TokenNumber specified was 0, then this field corresponds to the null-terminated
  /// ASCII string associated with the token's namespace Guid. If NULL, there is no
  /// name associated with this request.
  ///
  CHAR8       *PcdName;
} PCD_INFO;


/**
  Retrieve additional information associated with a PCD token.


VOID
EFIAPI
LibPcdGetInfo (
  IN        UINTN     TokenNumber,
  OUT       PCD_INFO  *PcdInfo
  );

/**

VOID
EFIAPI
LibPcdGetInfoEx (
  IN CONST  GUID      *Guid,
  IN        UINTN     TokenNumber,
  OUT       PCD_INFO  *PcdInfo
  );

/**




/// Flags bitmask values use in UnicodeValueToString() and
/// AsciiValueToString()
///
#define LEFT_JUSTIFY  0x01
#define COMMA_TYPE    0x08
#define PREFIX_ZERO   0x20
#define RADIX_HEX     0x80

/**
  Produces a Null-terminated Unicode string in an output buffer based on

  ...
  );

#ifndef DISABLE_NEW_DEPRECATED_INTERFACES

/**
  [ATTENTION] This function is deprecated for security reason.

  Converts a decimal value to a Null-terminated Unicode string.

  Converts the decimal number specified by Value to a Null-terminated Unicode
  string specified by Buffer containing at most Width characters. No padding of spaces
  is ever performed. If Width is 0 then a width of MAXIMUM_VALUE_CHARACTERS is assumed.
  The number of Unicode characters in Buffer is returned, not including the Null-terminator.
  If the conversion contains more than Width characters, then only the first
  Width characters are returned, and the total number of characters
  required to perform the conversion is returned.
  Additional conversion parameters are specified in Flags.

  The Flags bit LEFT_JUSTIFY is always ignored.
  All conversions are left justified in Buffer.
  If Width is 0, PREFIX_ZERO is ignored in Flags.
  If COMMA_TYPE is set in Flags, then PREFIX_ZERO is ignored in Flags, and commas
  are inserted every 3rd digit starting from the right.
  If RADIX_HEX is set in Flags, then the output buffer will be
  formatted in hexadecimal format.
  If Value is < 0 and RADIX_HEX is not set in Flags, then the fist character in Buffer is a '-'.
  If PREFIX_ZERO is set in Flags and PREFIX_ZERO is not being ignored,
  then Buffer is padded with '0' characters so the combination of the optional '-'
  sign character, '0' characters, digit characters for Value, and the Null-terminator
  add up to Width characters.
  If both COMMA_TYPE and RADIX_HEX are set in Flags, then ASSERT().
  If Buffer is NULL, then ASSERT().
  If Buffer is not aligned on a 16-bit boundary, then ASSERT().
  If unsupported bits are set in Flags, then ASSERT().
  If both COMMA_TYPE and RADIX_HEX are set in Flags, then ASSERT().
  If Width >= MAXIMUM_VALUE_CHARACTERS, then ASSERT()

  @param  Buffer  The pointer to the output buffer for the produced Null-terminated
                  Unicode string.
  @param  Flags   The bitmask of flags that specify left justification, zero pad, and commas.
  @param  Value   The 64-bit signed value to convert to a string.
  @param  Width   The maximum number of Unicode characters to place in Buffer, not including
                  the Null-terminator.

  @return The number of Unicode characters in Buffer, not including the Null-terminator.

**/
UINTN
EFIAPI
UnicodeValueToString (
  IN OUT CHAR16  *Buffer,
  IN UINTN       Flags,
  IN INT64       Value,
  IN UINTN       Width
  );

#endif

/**
  Converts a decimal value to a Null-terminated Unicode string.


UINTN
EFIAPI
AsciiVSPrint (
  OUT CHAR8        *StartOfBuffer,
  IN  UINTN        BufferSize,
  IN  CONST CHAR8  *FormatString,
  IN  VA_LIST      Marker
  );

/**

UINTN
EFIAPI
AsciiBSPrint (
  OUT CHAR8        *StartOfBuffer,
  IN  UINTN        BufferSize,
  IN  CONST CHAR8  *FormatString,
  IN  BASE_LIST    Marker
  );

/**

  ...
  );

#ifndef DISABLE_NEW_DEPRECATED_INTERFACES

/**
  [ATTENTION] This function is deprecated for security reason.

  Converts a decimal value to a Null-terminated ASCII string.

  Converts the decimal number specified by Value to a Null-terminated ASCII string
  specified by Buffer containing at most Width characters. No padding of spaces
  is ever performed.
  If Width is 0 then a width of  MAXIMUM_VALUE_CHARACTERS is assumed.
  The number of ASCII characters in Buffer is returned, not including the Null-terminator.
  If the conversion contains more than Width characters, then only the first Width
  characters are returned, and the total number of characters required to perform
  the conversion is returned.
  Additional conversion parameters are specified in Flags.
  The Flags bit LEFT_JUSTIFY is always ignored.
  All conversions are left justified in Buffer.
  If Width is 0, PREFIX_ZERO is ignored in Flags.
  If COMMA_TYPE is set in Flags, then PREFIX_ZERO is ignored in Flags, and commas
  are inserted every 3rd digit starting from the right.
  If RADIX_HEX is set in Flags, then the output buffer will be
  formatted in hexadecimal format.
  If Value is < 0 and RADIX_HEX is not set in Flags, then the fist character in Buffer is a '-'.
  If PREFIX_ZERO is set in Flags and PREFIX_ZERO is not being ignored,
  then Buffer is padded with '0' characters so the combination of the optional '-'
  sign character, '0' characters, digit characters for Value, and the Null-terminator
  add up to Width characters.

  If Buffer is NULL, then ASSERT().
  If unsupported bits are set in Flags, then ASSERT().
  If both COMMA_TYPE and RADIX_HEX are set in Flags, then ASSERT().
  If Width >= MAXIMUM_VALUE_CHARACTERS, then ASSERT()

  @param  Buffer  A pointer to the output buffer for the produced Null-terminated
                  ASCII string.
  @param  Flags   The bitmask of flags that specify left justification, zero pad, and commas.
  @param  Value   The 64-bit signed value to convert to a string.
  @param  Width   The maximum number of ASCII characters to place in Buffer, not including
                  the Null-terminator.

  @return The number of ASCII characters in Buffer, not including the Null-terminator.

**/
UINTN
EFIAPI
AsciiValueToString (
  OUT CHAR8      *Buffer,
  IN  UINTN      Flags,
  IN  INT64      Value,
  IN  UINTN      Width
  );

#endif

/**
  Converts a decimal value to a Null-terminated Ascii string.


RETURN_STATUS
EFIAPI
AsciiValueToStringS (
  IN OUT CHAR8  *Buffer,
  IN UINTN      BufferSize,
  IN UINTN      Flags,
  IN INT64      Value,
  IN UINTN      Width
  );

/**

UINTN
EFIAPI
SPrintLength (
  IN  CONST CHAR16  *FormatString,
  IN  VA_LIST       Marker
  );


UINTN
EFIAPI
SPrintLengthAsciiFormat (
  IN  CONST CHAR8  *FormatString,
  IN  VA_LIST      Marker
  );

#endif




///
/// Cache the Image Handle
///
extern EFI_HANDLE  gImageHandle;

///
/// Cache pointer to the EFI System Table
///
extern EFI_SYSTEM_TABLE  *gST;

///
/// Cache pointer to the EFI Boot Services Table




#ifndef __DEBUG_PORT_H__
#define __DEBUG_PORT_H__


///
/// DebugPortIo protocol {EBA4E8D2-3858-41EC-A281-2647BA9660D0}
///

    0xEBA4E8D2, 0x3858, 0x41EC, {0xA2, 0x81, 0x26, 0x47, 0xBA, 0x96, 0x60, 0xD0 } \
  }

extern EFI_GUID  gEfiDebugPortProtocolGuid;

typedef struct _EFI_DEBUGPORT_PROTOCOL EFI_DEBUGPORT_PROTOCOL;


/// This protocol provides the communication link between the debug agent and the remote host.
///
struct _EFI_DEBUGPORT_PROTOCOL {
  EFI_DEBUGPORT_RESET    Reset;
  EFI_DEBUGPORT_WRITE    Write;
  EFI_DEBUGPORT_READ     Read;
  EFI_DEBUGPORT_POLL     Poll;
};

//
// DEBUGPORT variable definitions...
//
#define EFI_DEBUGPORT_VARIABLE_NAME  L"DEBUGPORT"
#define EFI_DEBUGPORT_VARIABLE_GUID  EFI_DEBUGPORT_PROTOCOL_GUID

extern EFI_GUID  gEfiDebugPortVariableGuid;

//
// DebugPort device path definitions...
//
#define DEVICE_PATH_MESSAGING_DEBUGPORT  EFI_DEBUGPORT_PROTOCOL_GUID

extern EFI_GUID  gEfiDebugPortDevicePathGuid;

typedef struct {
  EFI_DEVICE_PATH_PROTOCOL    Header;
  EFI_GUID                    Guid;
} DEBUGPORT_DEVICE_PATH;

#endif




  that make up the Device Path.
**/
typedef struct {
  UINT8    Type;    ///< 0x01 Hardware Device Path.
                    ///< 0x02 ACPI Device Path.
                    ///< 0x03 Messaging Device Path.
                    ///< 0x04 Media Device Path.
                    ///< 0x05 BIOS Boot Specification Device Path.
                    ///< 0x7F End of Hardware Device Path.

  UINT8    SubType; ///< Varies by Type
                    ///< 0xFF End Entire Device Path, or
                    ///< 0x01 End This Instance of a Device Path and start a new
                    ///< Device Path.

  UINT8    Length[2]; ///< Specific Device Path data. Type and Sub-Type define
                      ///< type of data. Size of data is included in Length.

} EFI_DEVICE_PATH_PROTOCOL;

///
/// Device Path protocol definition for backward-compatible with EFI1.1.
///
typedef EFI_DEVICE_PATH_PROTOCOL EFI_DEVICE_PATH;

///
/// Hardware Device Paths.
///
#define HARDWARE_DEVICE_PATH  0x01

///
/// PCI Device Path SubType.
///
#define HW_PCI_DP  0x01

///
/// PCI Device Path.
///
typedef struct {
  EFI_DEVICE_PATH_PROTOCOL    Header;
  ///
  /// PCI Function Number.
  ///
  UINT8                       Function;
  ///
  /// PCI Device Number.
  ///
  UINT8                       Device;
} PCI_DEVICE_PATH;

///
/// PCCARD Device Path SubType.
///
#define HW_PCCARD_DP  0x02

///
/// PCCARD Device Path.
///
typedef struct {
  EFI_DEVICE_PATH_PROTOCOL    Header;
  ///
  /// Function Number (0 = First Function).
  ///
  UINT8                       FunctionNumber;
} PCCARD_DEVICE_PATH;

///
/// Memory Mapped Device Path SubType.
///
#define HW_MEMMAP_DP  0x03

///
/// Memory Mapped Device Path.
///
typedef struct {
  EFI_DEVICE_PATH_PROTOCOL    Header;
  ///
  /// EFI_MEMORY_TYPE
  ///
  UINT32                      MemoryType;
  ///
  /// Starting Memory Address.
  ///
  EFI_PHYSICAL_ADDRESS        StartingAddress;
  ///
  /// Ending Memory Address.
  ///
  EFI_PHYSICAL_ADDRESS        EndingAddress;
} MEMMAP_DEVICE_PATH;

///
/// Hardware Vendor Device Path SubType.
///
#define HW_VENDOR_DP  0x04

///
/// The Vendor Device Path allows the creation of vendor-defined Device Paths. A vendor must

/// contents on the n bytes that follow in the Vendor Device Path node.
///
typedef struct {
  EFI_DEVICE_PATH_PROTOCOL    Header;
  ///
  /// Vendor-assigned GUID that defines the data that follows.
  ///
  EFI_GUID                    Guid;
  ///
  /// Vendor-defined variable size data.
  ///

///
/// Controller Device Path SubType.
///
#define HW_CONTROLLER_DP  0x05

///
/// Controller Device Path.
///
typedef struct {
  EFI_DEVICE_PATH_PROTOCOL    Header;
  ///
  /// Controller number.
  ///
  UINT32                      ControllerNumber;
} CONTROLLER_DEVICE_PATH;

///
/// BMC Device Path SubType.
///
#define HW_BMC_DP  0x06

///
/// BMC Device Path.
///
typedef struct {
  EFI_DEVICE_PATH_PROTOCOL    Header;
  ///
  /// Interface Type.
  ///
  UINT8                       InterfaceType;
  ///
  /// Base Address.
  ///
  UINT8                       BaseAddress[8];
} BMC_DEVICE_PATH;

///
/// ACPI Device Paths.
///
#define ACPI_DEVICE_PATH  0x02

///
/// ACPI Device Path SubType.
///
#define ACPI_DP  0x01
typedef struct {
  EFI_DEVICE_PATH_PROTOCOL    Header;
  ///
  /// Device's PnP hardware ID stored in a numeric 32-bit
  /// compressed EISA-type ID. This value must match the
  /// corresponding _HID in the ACPI name space.
  ///
  UINT32                      HID;
  ///
  /// Unique ID that is required by ACPI if two devices have the
  /// same _HID. This value must also match the corresponding

  /// numeric value type of _UID is supported. Thus, strings must
  /// not be used for the _UID in the ACPI name space.
  ///
  UINT32                      UID;
} ACPI_HID_DEVICE_PATH;

///
/// Expanded ACPI Device Path SubType.
///
#define ACPI_EXTENDED_DP  0x02
typedef struct {
  EFI_DEVICE_PATH_PROTOCOL    Header;
  ///
  /// Device's PnP hardware ID stored in a numeric 32-bit
  /// compressed EISA-type ID. This value must match the
  /// corresponding _HID in the ACPI name space.
  ///
  UINT32                      HID;
  ///
  /// Unique ID that is required by ACPI if two devices have the
  /// same _HID. This value must also match the corresponding
  /// _UID/_HID pair in the ACPI name space.
  ///
  UINT32                      UID;
  ///
  /// Device's compatible PnP hardware ID stored in a numeric
  /// 32-bit compressed EISA-type ID. This value must match at
  /// least one of the compatible device IDs returned by the
  /// corresponding _CID in the ACPI name space.
  ///
  UINT32                      CID;
  ///
  /// Optional variable length _HIDSTR.
  /// Optional variable length _UIDSTR.

//   bits[31:16] - binary number
//    Compressed ASCII is 5 bits per character 0b00001 = 'A' 0b11010 = 'Z'
//
#define PNP_EISA_ID_CONST  0x41d0
#define EISA_ID(_Name, _Num)  ((UINT32)((_Name) | (_Num) << 16))
#define EISA_PNP_ID(_PNPId)   (EISA_ID(PNP_EISA_ID_CONST, (_PNPId)))
#define EFI_PNP_ID(_PNPId)    (EISA_ID(PNP_EISA_ID_CONST, (_PNPId)))

#define PNP_EISA_ID_MASK  0xffff
#define EISA_ID_TO_NUM(_Id)  ((_Id) >> 16)

///
/// ACPI _ADR Device Path SubType.
///
#define ACPI_ADR_DP  0x03

///
/// The _ADR device path is used to contain video output device attributes to support the Graphics

/// devices are displaying the same output.
///
typedef struct {
  EFI_DEVICE_PATH_PROTOCOL    Header;
  ///
  /// _ADR value. For video output devices the value of this
  /// field comes from Table B-2 of the ACPI 3.0 specification. At
  /// least one _ADR value is required.
  ///
  UINT32                      ADR;
  //
  // This device path may optionally contain more than one _ADR entry.
  //

///
/// ACPI NVDIMM Device Path SubType.
///
#define ACPI_NVDIMM_DP  0x04
///
///
typedef struct {
  EFI_DEVICE_PATH_PROTOCOL    Header;
  ///
  /// NFIT Device Handle, the _ADR of the NVDIMM device.
  /// The value of this field comes from Section 9.20.3 of the ACPI 6.2A specification.
  ///
  UINT32                      NFITDeviceHandle;
} ACPI_NVDIMM_DEVICE_PATH;

#define ACPI_ADR_DISPLAY_TYPE_OTHER             0

/// system. This Device Path can describe physical messaging information like SCSI ID, or abstract
/// information like networking protocol IP addresses.
///
#define MESSAGING_DEVICE_PATH  0x03

///
/// ATAPI Device Path SubType
///
#define MSG_ATAPI_DP  0x01
typedef struct {
  EFI_DEVICE_PATH_PROTOCOL    Header;
  ///
  /// Set to zero for primary, or one for secondary.
  ///
  UINT8                       PrimarySecondary;
  ///
  /// Set to zero for master, or one for slave mode.
  ///
  UINT8                       SlaveMaster;
  ///
  /// Logical Unit Number.
  ///
  UINT16                      Lun;
} ATAPI_DEVICE_PATH;

///
/// SCSI Device Path SubType.
///
#define MSG_SCSI_DP  0x02
typedef struct {
  EFI_DEVICE_PATH_PROTOCOL    Header;
  ///
  /// Target ID on the SCSI bus (PUN).
  ///
  UINT16                      Pun;
  ///
  /// Logical Unit Number (LUN).
  ///
  UINT16                      Lun;
} SCSI_DEVICE_PATH;

///
/// Fibre Channel SubType.
///
#define MSG_FIBRECHANNEL_DP  0x03
typedef struct {
  EFI_DEVICE_PATH_PROTOCOL    Header;
  ///
  /// Reserved for the future.
  ///
  UINT32                      Reserved;
  ///
  /// Fibre Channel World Wide Number.
  ///
  UINT64                      WWN;
  ///
  /// Fibre Channel Logical Unit Number.
  ///
  UINT64                      Lun;
} FIBRECHANNEL_DEVICE_PATH;

///
/// Fibre Channel Ex SubType.
///
#define MSG_FIBRECHANNELEX_DP  0x15
typedef struct {
  EFI_DEVICE_PATH_PROTOCOL    Header;
  ///
  /// Reserved for the future.
  ///
  UINT32                      Reserved;
  ///
  /// 8 byte array containing Fibre Channel End Device Port Name.
  ///
  UINT8                       WWN[8];
  ///
  /// 8 byte array containing Fibre Channel Logical Unit Number.
  ///
  UINT8                       Lun[8];
} FIBRECHANNELEX_DEVICE_PATH;

///
/// 1394 Device Path SubType
///
#define MSG_1394_DP  0x04
typedef struct {
  EFI_DEVICE_PATH_PROTOCOL    Header;
  ///
  /// Reserved for the future.
  ///
  UINT32                      Reserved;
  ///
  /// 1394 Global Unique ID (GUID).
  ///
  UINT64                      Guid;
} F1394_DEVICE_PATH;

///
/// USB Device Path SubType.
///
#define MSG_USB_DP  0x05
typedef struct {
  EFI_DEVICE_PATH_PROTOCOL    Header;
  ///
  /// USB Parent Port Number.
  ///
  UINT8                       ParentPortNumber;
  ///
  /// USB Interface Number.
  ///
  UINT8                       InterfaceNumber;
} USB_DEVICE_PATH;

///
/// USB Class Device Path SubType.
///
#define MSG_USB_CLASS_DP  0x0f
typedef struct {
  EFI_DEVICE_PATH_PROTOCOL    Header;
  ///
  /// Vendor ID assigned by USB-IF. A value of 0xFFFF will
  /// match any Vendor ID.
  ///
  UINT16                      VendorId;
  ///
  /// Product ID assigned by USB-IF. A value of 0xFFFF will
  /// match any Product ID.
  ///
  UINT16                      ProductId;
  ///
  /// The class code assigned by the USB-IF. A value of 0xFF
  /// will match any class code.
  ///
  UINT8                       DeviceClass;
  ///
  /// The subclass code assigned by the USB-IF. A value of
  /// 0xFF will match any subclass code.
  ///
  UINT8                       DeviceSubClass;
  ///
  /// The protocol code assigned by the USB-IF. A value of
  /// 0xFF will match any protocol code.
  ///
  UINT8                       DeviceProtocol;
} USB_CLASS_DEVICE_PATH;

///
/// USB WWID Device Path SubType.
///
#define MSG_USB_WWID_DP  0x10

///
/// This device path describes a USB device using its serial number.
///
typedef struct {
  EFI_DEVICE_PATH_PROTOCOL    Header;
  ///
  /// USB interface number.
  ///
  UINT16                      InterfaceNumber;
  ///
  /// USB vendor id of the device.
  ///
  UINT16                      VendorId;
  ///
  /// USB product id of the device.
  ///
  UINT16                      ProductId;
  ///
  /// Last 64-or-fewer UTF-16 characters of the USB
  /// serial number. The length of the string is

///
#define MSG_DEVICE_LOGICAL_UNIT_DP  0x11
typedef struct {
  EFI_DEVICE_PATH_PROTOCOL    Header;
  ///
  /// Logical Unit Number for the interface.
  ///
  UINT8                       Lun;
} DEVICE_LOGICAL_UNIT_DEVICE_PATH;

///
/// SATA Device Path SubType.
///
#define MSG_SATA_DP  0x12
typedef struct {
  EFI_DEVICE_PATH_PROTOCOL    Header;
  ///
  /// The HBA port number that facilitates the connection to the
  /// device or a port multiplier. The value 0xFFFF is reserved.
  ///
  UINT16                      HBAPortNumber;
  ///
  /// The Port multiplier port number that facilitates the connection
  /// to the device. Must be set to 0xFFFF if the device is directly
  /// connected to the HBA.
  ///
  UINT16                      PortMultiplierPortNumber;
  ///
  /// Logical Unit Number.
  ///
  UINT16                      Lun;
} SATA_DEVICE_PATH;

///
/// Flag for if the device is directly connected to the HBA.
///
#define SATA_HBA_DIRECT_CONNECT_FLAG  0x8000

///
/// I2O Device Path SubType.
///
#define MSG_I2O_DP  0x06
typedef struct {
  EFI_DEVICE_PATH_PROTOCOL    Header;
  ///
  /// Target ID (TID) for a device.
  ///
  UINT32                      Tid;
} I2O_DEVICE_PATH;

///
/// MAC Address Device Path SubType.
///
#define MSG_MAC_ADDR_DP  0x0b
typedef struct {
  EFI_DEVICE_PATH_PROTOCOL    Header;
  ///
  /// The MAC address for a network interface padded with 0s.
  ///
  EFI_MAC_ADDRESS             MacAddress;
  ///
  /// Network interface type(i.e. 802.3, FDDI).
  ///
  UINT8                       IfType;
} MAC_ADDR_DEVICE_PATH;

///
/// IPv4 Device Path SubType
///
#define MSG_IPv4_DP  0x0c
typedef struct {
  EFI_DEVICE_PATH_PROTOCOL    Header;
  ///
  /// The local IPv4 address.
  ///
  EFI_IPv4_ADDRESS            LocalIpAddress;
  ///
  /// The remote IPv4 address.
  ///
  EFI_IPv4_ADDRESS            RemoteIpAddress;
  ///
  /// The local port number.
  ///
  UINT16                      LocalPort;
  ///
  /// The remote port number.
  ///
  UINT16                      RemotePort;
  ///
  /// The network protocol(i.e. UDP, TCP).
  ///
  UINT16                      Protocol;
  ///
  /// 0x00 - The Source IP Address was assigned though DHCP.
  /// 0x01 - The Source IP Address is statically bound.
  ///
  BOOLEAN                     StaticIpAddress;
  ///
  /// The gateway IP address
  ///
  EFI_IPv4_ADDRESS            GatewayIpAddress;
  ///
  /// The subnet mask
  ///
  EFI_IPv4_ADDRESS            SubnetMask;
} IPv4_DEVICE_PATH;

///
/// IPv6 Device Path SubType.
///
#define MSG_IPv6_DP  0x0d
typedef struct {
  EFI_DEVICE_PATH_PROTOCOL    Header;
  ///
  /// The local IPv6 address.
  ///
  EFI_IPv6_ADDRESS            LocalIpAddress;
  ///
  /// The remote IPv6 address.
  ///
  EFI_IPv6_ADDRESS            RemoteIpAddress;
  ///
  /// The local port number.
  ///
  UINT16                      LocalPort;
  ///
  /// The remote port number.
  ///
  UINT16                      RemotePort;
  ///
  /// The network protocol(i.e. UDP, TCP).
  ///
  UINT16                      Protocol;
  ///
  /// 0x00 - The Local IP Address was manually configured.
  /// 0x01 - The Local IP Address is assigned through IPv6

  /// 0x02 - The Local IP Address is assigned through IPv6
  /// stateful configuration.
  ///
  UINT8                       IpAddressOrigin;
  ///
  /// The prefix length
  ///
  UINT8                       PrefixLength;
  ///
  /// The gateway IP address
  ///
  EFI_IPv6_ADDRESS            GatewayIpAddress;
} IPv6_DEVICE_PATH;

///
/// InfiniBand Device Path SubType.
///
#define MSG_INFINIBAND_DP  0x09
typedef struct {
  EFI_DEVICE_PATH_PROTOCOL    Header;
  ///
  /// Flags to help identify/manage InfiniBand device path elements:
  /// Bit 0 - IOC/Service (0b = IOC, 1b = Service).

  /// Bit 4 - Network Protocol.
  /// All other bits are reserved.
  ///
  UINT32    ResourceFlags;
  ///
  /// 128-bit Global Identifier for remote fabric port.
  ///
  UINT8     PortGid[16];
  ///
  /// 64-bit unique identifier to remote IOC or server process.
  /// Interpretation of field specified by Resource Flags (bit 0).
  ///
  UINT64    ServiceId;
  ///
  /// 64-bit persistent ID of remote IOC port.
  ///
  UINT64    TargetPortId;
  ///
  /// 64-bit persistent ID of remote device.
  ///
  UINT64    DeviceId;
} INFINIBAND_DEVICE_PATH;

#define INFINIBAND_RESOURCE_FLAG_IOC_SERVICE                0x01

///
/// UART Device Path SubType.
///
#define MSG_UART_DP  0x0e
typedef struct {
  EFI_DEVICE_PATH_PROTOCOL    Header;
  ///
  /// Reserved.
  ///
  UINT32                      Reserved;
  ///
  /// The baud rate setting for the UART style device. A value of 0
  /// means that the device's default baud rate will be used.
  ///
  UINT64                      BaudRate;
  ///
  /// The number of data bits for the UART style device. A value
  /// of 0 means that the device's default number of data bits will be used.
  ///
  UINT8                       DataBits;
  ///
  /// The parity setting for the UART style device.
  /// Parity 0x00 - Default Parity.

  /// Parity 0x04 - Mark Parity.
  /// Parity 0x05 - Space Parity.
  ///
  UINT8    Parity;
  ///
  /// The number of stop bits for the UART style device.
  /// Stop Bits 0x00 - Default Stop Bits.

  /// Stop Bits 0x02 - 1.5 Stop Bits.
  /// Stop Bits 0x03 - 2 Stop Bits.
  ///
  UINT8    StopBits;
} UART_DEVICE_PATH;

///
/// NVDIMM Namespace Device Path SubType.
///
#define NVDIMM_NAMESPACE_DP  0x20
typedef struct {
  EFI_DEVICE_PATH_PROTOCOL    Header;
  ///
  /// Namespace unique label identifier UUID.
  ///
  EFI_GUID                    Uuid;
} NVDIMM_NAMESPACE_DEVICE_PATH;

//
// Use VENDOR_DEVICE_PATH struct
//
#define MSG_VENDOR_DP  0x0a
typedef VENDOR_DEVICE_PATH VENDOR_DEFINED_DEVICE_PATH;

#define DEVICE_PATH_MESSAGING_PC_ANSI      EFI_PC_ANSI_GUID
#define DEVICE_PATH_MESSAGING_VT_100       EFI_VT_100_GUID
#define DEVICE_PATH_MESSAGING_VT_100_PLUS  EFI_VT_100_PLUS_GUID
#define DEVICE_PATH_MESSAGING_VT_UTF8      EFI_VT_UTF8_GUID

///
/// A new device path node is defined to declare flow control characteristics.
/// UART Flow Control Messaging Device Path
///
typedef struct {
  EFI_DEVICE_PATH_PROTOCOL    Header;
  ///
  /// DEVICE_PATH_MESSAGING_UART_FLOW_CONTROL GUID.
  ///
  EFI_GUID                    Guid;
  ///
  /// Bitmap of supported flow control types.
  /// Bit 0 set indicates hardware flow control.
  /// Bit 1 set indicates Xon/Xoff flow control.
  /// All other bits are reserved and are clear.
  ///
  UINT32                      FlowControlMap;
} UART_FLOW_CONTROL_DEVICE_PATH;

#define UART_FLOW_CONTROL_HARDWARE  0x00000001
#define UART_FLOW_CONTROL_XON_XOFF  0x00000010

#define DEVICE_PATH_MESSAGING_SAS  EFI_SAS_DEVICE_PATH_GUID
///
/// Serial Attached SCSI (SAS) Device Path.
///
typedef struct {
  EFI_DEVICE_PATH_PROTOCOL    Header;
  ///
  /// DEVICE_PATH_MESSAGING_SAS GUID.
  ///
  EFI_GUID                    Guid;
  ///
  /// Reserved for future use.
  ///
  UINT32                      Reserved;
  ///
  /// SAS Address for Serial Attached SCSI Target.
  ///
  UINT64                      SasAddress;
  ///
  /// SAS Logical Unit Number.
  ///
  UINT64                      Lun;
  ///
  /// More Information about the device and its interconnect.
  ///
  UINT16                      DeviceTopology;
  ///
  /// Relative Target Port (RTP).
  ///
  UINT16                      RelativeTargetPort;
} SAS_DEVICE_PATH;

///
/// Serial Attached SCSI (SAS) Ex Device Path SubType
///
#define MSG_SASEX_DP  0x16
typedef struct {
  EFI_DEVICE_PATH_PROTOCOL    Header;
  ///
  /// 8-byte array of the SAS Address for Serial Attached SCSI Target Port.
  ///
  UINT8                       SasAddress[8];
  ///
  /// 8-byte array of the SAS Logical Unit Number.
  ///
  UINT8                       Lun[8];
  ///
  /// More Information about the device and its interconnect.
  ///
  UINT16                      DeviceTopology;
  ///
  /// Relative Target Port (RTP).
  ///
  UINT16                      RelativeTargetPort;
} SASEX_DEVICE_PATH;

///
/// NvmExpress Namespace Device Path SubType.
///
#define MSG_NVME_NAMESPACE_DP  0x17
typedef struct {
  EFI_DEVICE_PATH_PROTOCOL    Header;
  UINT32                      NamespaceId;
  UINT64                      NamespaceUuid;
} NVME_NAMESPACE_DEVICE_PATH;

///
/// DNS Device Path SubType
///
#define MSG_DNS_DP  0x1F
typedef struct {
  EFI_DEVICE_PATH_PROTOCOL    Header;
  ///
  /// Indicates the DNS server address is IPv4 or IPv6 address.
  ///
  UINT8                       IsIPv6;
  ///
  /// Instance of the DNS server address.
  ///
  EFI_IP_ADDRESS              DnsServerIp[];
} DNS_DEVICE_PATH;

///
/// Uniform Resource Identifiers (URI) Device Path SubType
///
#define MSG_URI_DP  0x18
typedef struct {
  EFI_DEVICE_PATH_PROTOCOL    Header;
  ///
  /// Instance of the URI pursuant to RFC 3986.
  ///
  CHAR8                       Uri[];
} URI_DEVICE_PATH;

///
/// Universal Flash Storage (UFS) Device Path SubType.
///
#define MSG_UFS_DP  0x19
typedef struct {
  EFI_DEVICE_PATH_PROTOCOL    Header;
  ///
  /// Target ID on the UFS bus (PUN).
  ///
  UINT8                       Pun;
  ///
  /// Logical Unit Number (LUN).
  ///
  UINT8                       Lun;
} UFS_DEVICE_PATH;

///
/// SD (Secure Digital) Device Path SubType.
///
#define MSG_SD_DP  0x1A
typedef struct {
  EFI_DEVICE_PATH_PROTOCOL    Header;
  UINT8                       SlotNumber;
} SD_DEVICE_PATH;

///
/// EMMC (Embedded MMC) Device Path SubType.
///
#define MSG_EMMC_DP  0x1D
typedef struct {
  EFI_DEVICE_PATH_PROTOCOL    Header;
  UINT8                       SlotNumber;
} EMMC_DEVICE_PATH;

///
/// iSCSI Device Path SubType
///
#define MSG_ISCSI_DP  0x13
typedef struct {
  EFI_DEVICE_PATH_PROTOCOL    Header;
  ///
  /// Network Protocol (0 = TCP, 1+ = reserved).
  ///
  UINT16                      NetworkProtocol;
  ///
  /// iSCSI Login Options.
  ///
  UINT16                      LoginOption;
  ///
  /// iSCSI Logical Unit Number.
  ///
  UINT64                      Lun;
  ///
  /// iSCSI Target Portal group tag the initiator intends
  /// to establish a session with.
  ///
  UINT16                      TargetPortalGroupTag;
  ///
  /// iSCSI NodeTarget Name. The length of the name
  /// is determined by subtracting the offset of this field from Length.

  /// CHAR8                        iSCSI Target Name.
} ISCSI_DEVICE_PATH;

#define ISCSI_LOGIN_OPTION_NO_HEADER_DIGEST            0x0000
#define ISCSI_LOGIN_OPTION_HEADER_DIGEST_USING_CRC32C  0x0002
#define ISCSI_LOGIN_OPTION_NO_DATA_DIGEST              0x0000
#define ISCSI_LOGIN_OPTION_DATA_DIGEST_USING_CRC32C    0x0008
#define ISCSI_LOGIN_OPTION_AUTHMETHOD_CHAP             0x0000
#define ISCSI_LOGIN_OPTION_AUTHMETHOD_NON              0x1000
#define ISCSI_LOGIN_OPTION_CHAP_BI                     0x0000
#define ISCSI_LOGIN_OPTION_CHAP_UNI                    0x2000

///
/// VLAN Device Path SubType.
///
#define MSG_VLAN_DP  0x14
typedef struct {
  EFI_DEVICE_PATH_PROTOCOL    Header;
  ///
  /// VLAN identifier (0-4094).
  ///
  UINT16                      VlanId;
} VLAN_DEVICE_PATH;

///
/// Bluetooth Device Path SubType.
///
#define MSG_BLUETOOTH_DP  0x1b
typedef struct {
  EFI_DEVICE_PATH_PROTOCOL    Header;
  ///
  /// 48bit Bluetooth device address.
  ///
  BLUETOOTH_ADDRESS           BD_ADDR;
} BLUETOOTH_DEVICE_PATH;

///
/// Wi-Fi Device Path SubType.
///
#define MSG_WIFI_DP  0x1C
typedef struct {
  EFI_DEVICE_PATH_PROTOCOL    Header;
  ///
  /// Service set identifier. A 32-byte octets string.
  ///
  UINT8                       SSId[32];
} WIFI_DEVICE_PATH;

///
/// Bluetooth LE Device Path SubType.
///
#define MSG_BLUETOOTH_LE_DP  0x1E
typedef struct {
  EFI_DEVICE_PATH_PROTOCOL    Header;
  BLUETOOTH_LE_ADDRESS        Address;
} BLUETOOTH_LE_DEVICE_PATH;

//
// Media Device Path
//
#define MEDIA_DEVICE_PATH  0x04

///
/// Hard Drive Media Device Path SubType.
///
#define MEDIA_HARDDRIVE_DP  0x01

///
/// The Hard Drive Media Device Path is used to represent a partition on a hard drive.
///
typedef struct {
  EFI_DEVICE_PATH_PROTOCOL    Header;
  ///
  /// Describes the entry in a partition table, starting with entry 1.
  /// Partition number zero represents the entire device. Valid
  /// partition numbers for a MBR partition are [1, 4]. Valid
  /// partition numbers for a GPT partition are [1, NumberOfPartitionEntries].
  ///
  UINT32                      PartitionNumber;
  ///
  /// Starting LBA of the partition on the hard drive.
  ///
  UINT64                      PartitionStart;
  ///
  /// Size of the partition in units of Logical Blocks.
  ///
  UINT64                      PartitionSize;
  ///
  /// Signature unique to this partition:
  /// If SignatureType is 0, this field has to be initialized with 16 zeros.

  /// The other 12 bytes are initialized with zeros.
  /// If SignatureType is 2, this field contains a 16 byte signature.
  ///
  UINT8                       Signature[16];
  ///
  /// Partition Format: (Unused values reserved).
  /// 0x01 - PC-AT compatible legacy MBR.
  /// 0x02 - GUID Partition Table.
  ///
  UINT8                       MBRType;
  ///
  /// Type of Disk Signature: (Unused values reserved).
  /// 0x00 - No Disk Signature.
  /// 0x01 - 32-bit signature from address 0x1b8 of the type 0x01 MBR.
  /// 0x02 - GUID signature.
  ///
  UINT8                       SignatureType;
} HARDDRIVE_DEVICE_PATH;

#define MBR_TYPE_PCAT                        0x01
#define MBR_TYPE_EFI_PARTITION_TABLE_HEADER  0x02

#define NO_DISK_SIGNATURE    0x00
#define SIGNATURE_TYPE_MBR   0x01
#define SIGNATURE_TYPE_GUID  0x02

///
/// CD-ROM Media Device Path SubType.
///
#define MEDIA_CDROM_DP  0x02

///
/// The CD-ROM Media Device Path is used to define a system partition that exists on a CD-ROM.
///
typedef struct {
  EFI_DEVICE_PATH_PROTOCOL    Header;
  ///
  /// Boot Entry number from the Boot Catalog. The Initial/Default entry is defined as zero.
  ///
  UINT32                      BootEntry;
  ///
  /// Starting RBA of the partition on the medium. CD-ROMs use Relative logical Block Addressing.
  ///
  UINT64                      PartitionStart;
  ///
  /// Size of the partition in units of Blocks, also called Sectors.
  ///
  UINT64                      PartitionSize;
} CDROM_DEVICE_PATH;

//
// Use VENDOR_DEVICE_PATH struct
//
#define MEDIA_VENDOR_DP  0x03           ///< Media vendor device path subtype.

///
/// File Path Media Device Path SubType
///
#define MEDIA_FILEPATH_DP  0x04
typedef struct {
  EFI_DEVICE_PATH_PROTOCOL    Header;
  ///
  /// A NULL-terminated Path string including directory and file names.
  ///
  CHAR16                      PathName[1];
} FILEPATH_DEVICE_PATH;

#define SIZE_OF_FILEPATH_DEVICE_PATH  OFFSET_OF(FILEPATH_DEVICE_PATH,PathName)

///
/// Media Protocol Device Path SubType.
///
#define MEDIA_PROTOCOL_DP  0x05

///
/// The Media Protocol Device Path is used to denote the protocol that is being

/// Many protocols are inherent to the style of device path.
///
typedef struct {
  EFI_DEVICE_PATH_PROTOCOL    Header;
  ///
  /// The ID of the protocol.
  ///
  EFI_GUID                    Protocol;
} MEDIA_PROTOCOL_DEVICE_PATH;

///
/// PIWG Firmware File SubType.
///
#define MEDIA_PIWG_FW_FILE_DP  0x06

///
/// This device path is used by systems implementing the UEFI PI Specification 1.0 to describe a firmware file.
///
typedef struct {
  EFI_DEVICE_PATH_PROTOCOL    Header;
  ///
  /// Firmware file name
  ///
  EFI_GUID                    FvFileName;
} MEDIA_FW_VOL_FILEPATH_DEVICE_PATH;

///
/// PIWG Firmware Volume Device Path SubType.
///
#define MEDIA_PIWG_FW_VOL_DP  0x07

///
/// This device path is used by systems implementing the UEFI PI Specification 1.0 to describe a firmware volume.
///
typedef struct {
  EFI_DEVICE_PATH_PROTOCOL    Header;
  ///
  /// Firmware volume name.
  ///
  EFI_GUID                    FvName;
} MEDIA_FW_VOL_DEVICE_PATH;

///
/// Media relative offset range device path.
///
#define MEDIA_RELATIVE_OFFSET_RANGE_DP  0x08

///
/// Used to describe the offset range of media relative.
///
typedef struct {
  EFI_DEVICE_PATH_PROTOCOL    Header;
  UINT32                      Reserved;
  UINT64                      StartingOffset;
  UINT64                      EndingOffset;
} MEDIA_RELATIVE_OFFSET_RANGE_DEVICE_PATH;

///
/// This GUID defines a RAM Disk supporting a raw disk format in volatile memory.
///
#define EFI_VIRTUAL_DISK_GUID  EFI_ACPI_6_0_NFIT_GUID_RAM_DISK_SUPPORTING_VIRTUAL_DISK_REGION_VOLATILE

extern  EFI_GUID  gEfiVirtualDiskGuid;

///
/// This GUID defines a RAM Disk supporting an ISO image in volatile memory.
///
#define EFI_VIRTUAL_CD_GUID  EFI_ACPI_6_0_NFIT_GUID_RAM_DISK_SUPPORTING_VIRTUAL_CD_REGION_VOLATILE

extern  EFI_GUID  gEfiVirtualCdGuid;

///
/// This GUID defines a RAM Disk supporting a raw disk format in persistent memory.
///
#define EFI_PERSISTENT_VIRTUAL_DISK_GUID  EFI_ACPI_6_0_NFIT_GUID_RAM_DISK_SUPPORTING_VIRTUAL_DISK_REGION_PERSISTENT

extern  EFI_GUID  gEfiPersistentVirtualDiskGuid;

///
/// This GUID defines a RAM Disk supporting an ISO image in persistent memory.
///
#define EFI_PERSISTENT_VIRTUAL_CD_GUID  EFI_ACPI_6_0_NFIT_GUID_RAM_DISK_SUPPORTING_VIRTUAL_CD_REGION_PERSISTENT

extern  EFI_GUID  gEfiPersistentVirtualCdGuid;

///
/// Media ram disk device path.
///
#define MEDIA_RAM_DISK_DP  0x09

///
/// Used to describe the ram disk device path.
///
typedef struct {
  EFI_DEVICE_PATH_PROTOCOL    Header;
  ///
  /// Starting Memory Address.
  ///
  UINT32                      StartingAddr[2];
  ///
  /// Ending Memory Address.
  ///
  UINT32                      EndingAddr[2];
  ///
  /// GUID that defines the type of the RAM Disk.
  ///
  EFI_GUID                    TypeGuid;
  ///
  /// RAM Diskinstance number, if supported. The default value is zero.
  ///
  UINT16                      Instance;
} MEDIA_RAM_DISK_DEVICE_PATH;

///
/// BIOS Boot Specification Device Path.
///
#define BBS_DEVICE_PATH  0x05

///
/// BIOS Boot Specification Device Path SubType.
///
#define BBS_BBS_DP  0x01

///
/// This Device Path is used to describe the booting of non-EFI-aware operating systems.
///
typedef struct {
  EFI_DEVICE_PATH_PROTOCOL    Header;
  ///
  /// Device Type as defined by the BIOS Boot Specification.
  ///
  UINT16                      DeviceType;
  ///
  /// Status Flags as defined by the BIOS Boot Specification.
  ///
  UINT16                      StatusFlag;
  ///
  /// Null-terminated ASCII string that describes the boot device to a user.
  ///
  CHAR8                       String[1];
} BBS_BBS_DEVICE_PATH;

//
// DeviceType definitions - from BBS specification
//
#define BBS_TYPE_FLOPPY            0x01
#define BBS_TYPE_HARDDRIVE         0x02
#define BBS_TYPE_CDROM             0x03
#define BBS_TYPE_PCMCIA            0x04
#define BBS_TYPE_USB               0x05
#define BBS_TYPE_EMBEDDED_NETWORK  0x06
#define BBS_TYPE_BEV               0x80
#define BBS_TYPE_UNKNOWN           0xFF


///
/// Union of all possible Device Paths and pointers to Device Paths.

  BBS_BBS_DEVICE_PATH                        Bbs;
} EFI_DEV_PATH;



typedef union {
  EFI_DEVICE_PATH_PROTOCOL                   *DevPath;
  PCI_DEVICE_PATH                            *Pci;


#pragma pack()

#define END_DEVICE_PATH_TYPE              0x7f
#define END_ENTIRE_DEVICE_PATH_SUBTYPE    0xFF
#define END_INSTANCE_DEVICE_PATH_SUBTYPE  0x01

extern EFI_GUID  gEfiDevicePathProtocolGuid;

#endif





**/
typedef
EFI_DEVICE_PATH_PROTOCOL *
(EFIAPI *EFI_DEVICE_PATH_FROM_TEXT_NODE)(
  IN CONST CHAR16                 *TextDeviceNode
  );


/**
  Convert text to the binary representation of a device node.



**/
typedef
EFI_DEVICE_PATH_PROTOCOL *
(EFIAPI *EFI_DEVICE_PATH_FROM_TEXT_PATH)(
  IN CONST CHAR16                 *TextDevicePath
  );

/// This protocol converts text to device paths and device nodes.
///
typedef struct {
  EFI_DEVICE_PATH_FROM_TEXT_NODE    ConvertTextToDeviceNode;
  EFI_DEVICE_PATH_FROM_TEXT_PATH    ConvertTextToDevicePath;
} EFI_DEVICE_PATH_FROM_TEXT_PROTOCOL;

extern EFI_GUID  gEfiDevicePathFromTextProtocolGuid;

#endif





**/
typedef
CHAR16 *
(EFIAPI *EFI_DEVICE_PATH_TO_TEXT_NODE)(
  IN CONST EFI_DEVICE_PATH_PROTOCOL   *DeviceNode,
  IN BOOLEAN                          DisplayOnly,


**/
typedef
CHAR16 *
(EFIAPI *EFI_DEVICE_PATH_TO_TEXT_PATH)(
  IN CONST EFI_DEVICE_PATH_PROTOCOL   *DevicePath,
  IN BOOLEAN                          DisplayOnly,

/// This protocol converts device paths and device nodes to text.
///
typedef struct {
  EFI_DEVICE_PATH_TO_TEXT_NODE    ConvertDeviceNodeToText;
  EFI_DEVICE_PATH_TO_TEXT_PATH    ConvertDevicePathToText;
} EFI_DEVICE_PATH_TO_TEXT_PROTOCOL;

extern EFI_GUID  gEfiDevicePathToTextProtocolGuid;

#endif






  IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath
  );


/**
  Create a duplicate of the specified path.



**/
typedef
EFI_DEVICE_PATH_PROTOCOL *
(EFIAPI *EFI_DEVICE_PATH_UTILS_DUP_DEVICE_PATH)(
  IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath
  );


**/
typedef
EFI_DEVICE_PATH_PROTOCOL *
(EFIAPI *EFI_DEVICE_PATH_UTILS_APPEND_PATH)(
  IN CONST EFI_DEVICE_PATH_PROTOCOL *Src1,
  IN CONST EFI_DEVICE_PATH_PROTOCOL *Src2


**/
typedef
EFI_DEVICE_PATH_PROTOCOL *
(EFIAPI *EFI_DEVICE_PATH_UTILS_APPEND_NODE)(
  IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath,
  IN CONST EFI_DEVICE_PATH_PROTOCOL *DeviceNode


**/
typedef
EFI_DEVICE_PATH_PROTOCOL *
(EFIAPI *EFI_DEVICE_PATH_UTILS_APPEND_INSTANCE)(
  IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath,
  IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePathInstance


**/
typedef
EFI_DEVICE_PATH_PROTOCOL *
(EFIAPI *EFI_DEVICE_PATH_UTILS_GET_NEXT_INSTANCE)(
  IN  OUT EFI_DEVICE_PATH_PROTOCOL  **DevicePathInstance,
  OUT UINTN                         *DevicePathInstanceSize


**/
typedef
EFI_DEVICE_PATH_PROTOCOL *
(EFIAPI *EFI_DEVICE_PATH_UTILS_CREATE_NODE)(
  IN UINT8                          NodeType,
  IN UINT8                          NodeSubType,
  IN UINT16                         NodeLength
  );

/**
  Returns whether a device path is multi-instance.

/// This protocol is used to creates and manipulates device paths and device nodes.
///
typedef struct {
  EFI_DEVICE_PATH_UTILS_GET_DEVICE_PATH_SIZE    GetDevicePathSize;
  EFI_DEVICE_PATH_UTILS_DUP_DEVICE_PATH         DuplicateDevicePath;
  EFI_DEVICE_PATH_UTILS_APPEND_PATH             AppendDevicePath;
  EFI_DEVICE_PATH_UTILS_APPEND_NODE             AppendDeviceNode;
  EFI_DEVICE_PATH_UTILS_APPEND_INSTANCE         AppendDevicePathInstance;
  EFI_DEVICE_PATH_UTILS_GET_NEXT_INSTANCE       GetNextDevicePathInstance;
  EFI_DEVICE_PATH_UTILS_IS_MULTI_INSTANCE       IsDevicePathMultiInstance;
  EFI_DEVICE_PATH_UTILS_CREATE_NODE             CreateDeviceNode;
} EFI_DEVICE_PATH_UTILITIES_PROTOCOL;

extern EFI_GUID  gEfiDevicePathUtilitiesProtocolGuid;

#endif




    0x387477c1, 0x69c7, 0x11d2, {0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \
  }

typedef struct _EFI_SIMPLE_TEXT_INPUT_PROTOCOL EFI_SIMPLE_TEXT_INPUT_PROTOCOL;

///
/// Protocol GUID name defined in EFI1.1.
///
#define SIMPLE_INPUT_PROTOCOL  EFI_SIMPLE_TEXT_INPUT_PROTOCOL_GUID

///
/// Protocol name in EFI1.1 for backward-compatible.
///
typedef struct _EFI_SIMPLE_TEXT_INPUT_PROTOCOL SIMPLE_INPUT_INTERFACE;

///
/// The keystroke information for the key that was pressed.
///
typedef struct {
  UINT16    ScanCode;
  CHAR16    UnicodeChar;
} EFI_INPUT_KEY;

//

  @retval EFI_NOT_READY    There was no keystroke data available.
  @retval EFI_DEVICE_ERROR The keystroke information was not returned due to
                           hardware errors.
  @retval EFI_UNSUPPORTED  The device does not support the ability to read keystroke data.

**/
typedef

/// It is the minimum required protocol for ConsoleIn.
///
struct _EFI_SIMPLE_TEXT_INPUT_PROTOCOL {
  EFI_INPUT_RESET       Reset;
  EFI_INPUT_READ_KEY    ReadKeyStroke;
  ///
  /// Event to use with WaitForEvent() to wait for a key to be available
  ///
  EFI_EVENT             WaitForKey;
};

extern EFI_GUID  gEfiSimpleTextInProtocolGuid;

#endif




#define EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL_GUID \
  {0xdd9e7534, 0x7762, 0x4698, { 0x8c, 0x14, 0xf5, 0x85, 0x17, 0xa6, 0x25, 0xaa } }


typedef struct _EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL;

/**

(EFIAPI *EFI_INPUT_RESET_EX)(
  IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,
  IN BOOLEAN                           ExtendedVerification
  );


///
/// EFI_KEY_TOGGLE_STATE. The toggle states are defined.

  /// returned value is valid only if the high
  /// order bit has been set.
  ///
  UINT32                  KeyShiftState;
  ///
  /// Reflects the current internal state of
  /// various toggled attributes. The returned
  /// value is valid only if the high order
  /// bit has been set.
  ///
  EFI_KEY_TOGGLE_STATE    KeyToggleState;
} EFI_KEY_STATE;

typedef struct {
  ///
  /// The EFI scan code and Unicode value returned from the input device.
  ///
  EFI_INPUT_KEY    Key;
  ///
  /// The current state of various toggled attributes as well as input modifier values.
  ///
  EFI_KEY_STATE    KeyState;
} EFI_KEY_DATA;

//

//
// Shift state
//
#define EFI_SHIFT_STATE_VALID      0x80000000
#define EFI_RIGHT_SHIFT_PRESSED    0x00000001
#define EFI_LEFT_SHIFT_PRESSED     0x00000002
#define EFI_RIGHT_CONTROL_PRESSED  0x00000004
#define EFI_LEFT_CONTROL_PRESSED   0x00000008
#define EFI_RIGHT_ALT_PRESSED      0x00000010
#define EFI_LEFT_ALT_PRESSED       0x00000020
#define EFI_RIGHT_LOGO_PRESSED     0x00000040
#define EFI_LEFT_LOGO_PRESSED      0x00000080
#define EFI_MENU_KEY_PRESSED       0x00000100
#define EFI_SYS_REQ_PRESSED        0x00000200

//
// Toggle state
//
#define EFI_TOGGLE_STATE_VALID  0x80
#define EFI_KEY_STATE_EXPOSED   0x40
#define EFI_SCROLL_LOCK_ACTIVE  0x01
#define EFI_NUM_LOCK_ACTIVE     0x02
#define EFI_CAPS_LOCK_ACTIVE    0x04

//
// EFI Scan codes
//
#define SCAN_F11              0x0015
#define SCAN_F12              0x0016
#define SCAN_PAUSE            0x0048
#define SCAN_F13              0x0068
#define SCAN_F14              0x0069
#define SCAN_F15              0x006A
#define SCAN_F16              0x006B
#define SCAN_F17              0x006C
#define SCAN_F18              0x006D
#define SCAN_F19              0x006E
#define SCAN_F20              0x006F
#define SCAN_F21              0x0070
#define SCAN_F22              0x0071
#define SCAN_F23              0x0072
#define SCAN_F24              0x0073
#define SCAN_MUTE             0x007F
#define SCAN_VOLUME_UP        0x0080
#define SCAN_VOLUME_DOWN      0x0081
#define SCAN_BRIGHTNESS_UP    0x0100
#define SCAN_BRIGHTNESS_DOWN  0x0101
#define SCAN_SUSPEND          0x0102
#define SCAN_HIBERNATE        0x0103
#define SCAN_TOGGLE_DISPLAY   0x0104
#define SCAN_RECOVERY         0x0105
#define SCAN_EJECT            0x0106

/**
  The function reads the next keystroke from the input device. If

  @retval EFI_NOT_READY    There was no keystroke data available.
  @retval EFI_DEVICE_ERROR The keystroke information was not returned due to
                           hardware errors.
  @retval EFI_UNSUPPORTED  The device does not support the ability to read keystroke data.


**/

(EFIAPI *EFI_INPUT_READ_KEY_EX)(
  IN  EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,
  OUT EFI_KEY_DATA                      *KeyData
  );

/**
  The SetState() function allows the input device hardware to

(EFIAPI *EFI_SET_STATE)(
  IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,
  IN EFI_KEY_TOGGLE_STATE              *KeyToggleState
  );

///
/// The function will be called when the key sequence is typed specified by KeyData.

EFI_STATUS
(EFIAPI *EFI_KEY_NOTIFY_FUNCTION)(
  IN EFI_KEY_DATA *KeyData
  );

/**
  The RegisterKeystrokeNotify() function registers a function

  IN  EFI_KEY_DATA                      *KeyData,
  IN  EFI_KEY_NOTIFY_FUNCTION           KeyNotificationFunction,
  OUT VOID                              **NotifyHandle
  );

/**
  The UnregisterKeystrokeNotify() function removes the

(EFIAPI *EFI_UNREGISTER_KEYSTROKE_NOTIFY)(
  IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL  *This,
  IN VOID                               *NotificationHandle
  );


///
/// The EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL is used on the ConsoleIn

/// which allows a variety of extended shift state information to be
/// returned.
///
struct _EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL {
  EFI_INPUT_RESET_EX                 Reset;
  EFI_INPUT_READ_KEY_EX              ReadKeyStrokeEx;
  ///
  /// Event to use with WaitForEvent() to wait for a key to be available.
  ///
  EFI_EVENT                          WaitForKeyEx;
  EFI_SET_STATE                      SetState;
  EFI_REGISTER_KEYSTROKE_NOTIFY      RegisterKeyNotify;
  EFI_UNREGISTER_KEYSTROKE_NOTIFY    UnregisterKeyNotify;
};

extern EFI_GUID  gEfiSimpleTextInputExProtocolGuid;
extern EFI_GUID gEfiSimpleTextInputExProtocolGuid;

#endif





///
/// Protocol GUID defined in EFI1.1.
///
#define SIMPLE_TEXT_OUTPUT_PROTOCOL  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL_GUID

typedef struct _EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL;

///
/// Backward-compatible with EFI1.1.
///
typedef EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL SIMPLE_TEXT_OUTPUT_INTERFACE;

//
// Defines for required EFI Unicode Box Draw characters
//
#define BOXDRAW_HORIZONTAL                  0x2500
#define BOXDRAW_VERTICAL                    0x2502

//
// EFI Required Geometric Shapes Code Chart
//
#define GEOMETRICSHAPE_UP_TRIANGLE     0x25b2
#define GEOMETRICSHAPE_RIGHT_TRIANGLE  0x25ba
#define GEOMETRICSHAPE_DOWN_TRIANGLE   0x25bc
#define GEOMETRICSHAPE_LEFT_TRIANGLE   0x25c4

//
// EFI Required Arrow shapes
//
#define ARROW_LEFT   0x2190
#define ARROW_UP     0x2191
#define ARROW_RIGHT  0x2192
#define ARROW_DOWN   0x2193

//
// EFI Console Colours
//
#define EFI_BLACK         0x00
#define EFI_BLUE          0x01
#define EFI_GREEN         0x02
#define EFI_CYAN          (EFI_BLUE | EFI_GREEN)
#define EFI_RED           0x04
#define EFI_MAGENTA       (EFI_BLUE | EFI_RED)
#define EFI_BROWN         (EFI_GREEN | EFI_RED)
#define EFI_LIGHTGRAY     (EFI_BLUE | EFI_GREEN | EFI_RED)
#define EFI_BRIGHT        0x08
#define EFI_DARKGRAY      (EFI_BLACK | EFI_BRIGHT)
#define EFI_LIGHTBLUE     (EFI_BLUE | EFI_BRIGHT)
#define EFI_LIGHTGREEN    (EFI_GREEN | EFI_BRIGHT)
#define EFI_LIGHTCYAN     (EFI_CYAN | EFI_BRIGHT)
#define EFI_LIGHTRED      (EFI_RED | EFI_BRIGHT)
#define EFI_LIGHTMAGENTA  (EFI_MAGENTA | EFI_BRIGHT)
#define EFI_YELLOW        (EFI_BROWN | EFI_BRIGHT)
#define EFI_WHITE         (EFI_BLUE | EFI_GREEN | EFI_RED | EFI_BRIGHT)

//
// Macro to accept color values in their raw form to create

//
// Do not use EFI_BACKGROUND_xxx values with this macro.
//
#define EFI_TEXT_ATTR(Foreground, Background)  ((Foreground) | ((Background) << 4))

#define EFI_BACKGROUND_BLACK      0x00
#define EFI_BACKGROUND_BLUE       0x10

#define EFI_WIDE_ATTRIBUTE  0x80

/**
  Reset the text output device hardware and optionally run diagnostics

  @param  This                 The protocol instance pointer.
  @param  ExtendedVerification Driver may perform more exhaustive verification

  ///
  /// The number of modes supported by QueryMode () and SetMode ().
  ///
  INT32    MaxMode;

  //
  // current settings

  ///
  /// The text mode of the output device(s).
  ///
  INT32      Mode;
  ///
  /// The current character output attribute.
  ///
  INT32      Attribute;
  ///
  /// The cursor's column.
  ///
  INT32      CursorColumn;
  ///
  /// The cursor's row.
  ///
  INT32      CursorRow;
  ///
  /// The cursor is currently visible or not.
  ///
  BOOLEAN    CursorVisible;
} EFI_SIMPLE_TEXT_OUTPUT_MODE;

///

/// devices is at least 80 x 25 characters.
///
struct _EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL {
  EFI_TEXT_RESET                  Reset;

  EFI_TEXT_STRING                 OutputString;
  EFI_TEXT_TEST_STRING            TestString;

  EFI_TEXT_QUERY_MODE             QueryMode;
  EFI_TEXT_SET_MODE               SetMode;
  EFI_TEXT_SET_ATTRIBUTE          SetAttribute;

  EFI_TEXT_CLEAR_SCREEN           ClearScreen;
  EFI_TEXT_SET_CURSOR_POSITION    SetCursorPosition;
  EFI_TEXT_ENABLE_CURSOR          EnableCursor;

  ///
  /// Pointer to SIMPLE_TEXT_OUTPUT_MODE data.
  ///
  EFI_SIMPLE_TEXT_OUTPUT_MODE     *Mode;
};

extern EFI_GUID  gEfiSimpleTextOutProtocolGuid;

#endif

Lines 18-21 SPDX-License-Identifier: BSD-2-Clause-Patent Link Here

(-)b/sys/contrib/edk2/Include/Uefi.h (-1 lines)
18	#include <Uefi/UefiSpec.h>	18	#include <Uefi/UefiSpec.h>
19		19
20	#endif	20	#endif
21




/** @file
  Defines data types and constants introduced in UEFI.

Copyright (c) 2006 - 2021, Intel Corporation. All rights reserved.<BR>
Portions copyright (c) 2011 - 2016, ARM Ltd. All rights reserved.<BR>
Copyright (c) 2020, Hewlett Packard Enterprise Development LP. All rights reserved.<BR>
Copyright (c) 2022, Loongson Technology Corporation Limited. All rights reserved.<BR>

SPDX-License-Identifier: BSD-2-Clause-Patent


///
/// 128-bit buffer containing a unique identifier value.
///
typedef GUID EFI_GUID;
///
/// Function return status for EFI API.
///
typedef RETURN_STATUS EFI_STATUS;
///
/// A collection of related interfaces.
///
typedef VOID *EFI_HANDLE;
///
/// Handle to an event structure.
///
typedef VOID *EFI_EVENT;
///
/// Task priority level.
///
typedef UINTN EFI_TPL;
///
/// Logical block address.
///
typedef UINT64 EFI_LBA;

///
/// 64-bit physical memory address.
///
typedef UINT64 EFI_PHYSICAL_ADDRESS;

///
/// 64-bit virtual memory address.
///
typedef UINT64 EFI_VIRTUAL_ADDRESS;

///
/// EFI Time Abstraction:

///  TimeZone:   -1440 to 1440 or 2047
///
typedef struct {
  UINT16    Year;
  UINT8     Month;
  UINT8     Day;
  UINT8     Hour;
  UINT8     Minute;
  UINT8     Second;
  UINT8     Pad1;
  UINT32    Nanosecond;
  INT16     TimeZone;
  UINT8     Daylight;
  UINT8     Pad2;
} EFI_TIME;


///
/// 4-byte buffer. An IPv4 internet protocol address.
///

/// 32-byte buffer containing a network Media Access Control address.
///
typedef struct {
  UINT8    Addr[32];
} EFI_MAC_ADDRESS;

///

/// An IPv4 or IPv6 internet protocol address.
///
typedef union {
  UINT32              Addr[4];
  EFI_IPv4_ADDRESS    v4;
  EFI_IPv6_ADDRESS    v6;
} EFI_IP_ADDRESS;


///
/// Enumeration of EFI_STATUS.
///@{

#define EFI_END_OF_FILE           RETURN_END_OF_FILE
#define EFI_INVALID_LANGUAGE      RETURN_INVALID_LANGUAGE
#define EFI_COMPROMISED_DATA      RETURN_COMPROMISED_DATA
#define EFI_IP_ADDRESS_CONFLICT   RETURN_IP_ADDRESS_CONFLICT
#define EFI_HTTP_ERROR            RETURN_HTTP_ERROR

#define EFI_WARN_UNKNOWN_GLYPH     RETURN_WARN_UNKNOWN_GLYPH
#define EFI_WARN_DELETE_FAILURE    RETURN_WARN_DELETE_FAILURE
#define EFI_WARN_WRITE_FAILURE     RETURN_WARN_WRITE_FAILURE
#define EFI_WARN_BUFFER_TOO_SMALL  RETURN_WARN_BUFFER_TOO_SMALL
#define EFI_WARN_STALE_DATA        RETURN_WARN_STALE_DATA
#define EFI_WARN_FILE_SYSTEM       RETURN_WARN_FILE_SYSTEM
#define EFI_WARN_RESET_REQUIRED    RETURN_WARN_RESET_REQUIRED
///@}

///
/// Define macro to encode the status code.
///
#define EFIERR(_a)  ENCODE_ERROR(_a)

#define EFI_ERROR(A)  RETURN_ERROR(A)

///
/// ICMP error definitions

///
/// Tcp connection status definitions
///@{
#define EFI_CONNECTION_FIN      EFIERR(104)
#define EFI_CONNECTION_RESET    EFIERR(105)
#define EFI_CONNECTION_REFUSED  EFIERR(106)
///@}

//

// 4KB. This should in no way be confused with the page size of the processor.
// An EFI_PAGE is just the quanta of memory in EFI.
//
#define EFI_PAGE_SIZE   SIZE_4KB
#define EFI_PAGE_MASK   0xFFF
#define EFI_PAGE_SHIFT  12

/**
  Macro that converts a size, in bytes, to a number of EFI_PAGESs.

///
/// PE32+ Machine type for IA32 UEFI images.
///
#define EFI_IMAGE_MACHINE_IA32  0x014C

///
/// PE32+ Machine type for IA64 UEFI images.
///
#define EFI_IMAGE_MACHINE_IA64  0x0200

///
/// PE32+ Machine type for EBC UEFI images.
///
#define EFI_IMAGE_MACHINE_EBC  0x0EBC

///
/// PE32+ Machine type for X64 UEFI images.
///
#define EFI_IMAGE_MACHINE_X64  0x8664

///
/// PE32+ Machine type for ARM mixed ARM and Thumb/Thumb2 images.

#define EFI_IMAGE_MACHINE_RISCV64   0x5064
#define EFI_IMAGE_MACHINE_RISCV128  0x5128

///
/// PE32+ Machine type for LoongArch 32/64 images.
///
#define EFI_IMAGE_MACHINE_LOONGARCH32  0x6232
#define EFI_IMAGE_MACHINE_LOONGARCH64  0x6264

#if !defined (EFI_IMAGE_MACHINE_TYPE_VALUE) && !defined (EFI_IMAGE_MACHINE_CROSS_TYPE_VALUE)
  #if   defined (MDE_CPU_IA32)

#define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \
  ((Machine) == EFI_IMAGE_MACHINE_IA32)

#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine)  ((Machine) == EFI_IMAGE_MACHINE_X64)

  #elif defined (MDE_CPU_X64)

#define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \
  ((Machine) == EFI_IMAGE_MACHINE_X64)

#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine)  ((Machine) == EFI_IMAGE_MACHINE_IA32)

  #elif defined (MDE_CPU_ARM)

#define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine)  ((Machine) == EFI_IMAGE_MACHINE_ARMTHUMB_MIXED)

#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine)  (FALSE)

  #elif defined (MDE_CPU_AARCH64)

#define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \
  ((Machine) == EFI_IMAGE_MACHINE_AARCH64)

#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine)  (FALSE)

  #elif defined (MDE_CPU_RISCV64)
#define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \
  ((Machine) == EFI_IMAGE_MACHINE_RISCV64)

#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine)  (FALSE)

  #elif defined (MDE_CPU_LOONGARCH64)

#define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \
    ((Machine) == EFI_IMAGE_MACHINE_LOONGARCH64)

#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine)  (FALSE)

  #elif defined (MDE_CPU_EBC)

///
/// This is just to make sure you can cross compile with the EBC compiler.
/// It does not make sense to have a PE loader coded in EBC.
///
#define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine)  ((Machine) == EFI_IMAGE_MACHINE_EBC)

#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine)  (FALSE)

  #else
    #error Unknown Processor Type
  #endif
#else
  #if defined (EFI_IMAGE_MACHINE_TYPE_VALUE)
#define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine)  ((Machine) == EFI_IMAGE_MACHINE_TYPE_VALUE)
  #else
#define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine)  (FALSE)
  #endif
  #if defined (EFI_IMAGE_MACHINE_CROSS_TYPE_VALUE)
#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine)  ((Machine) == EFI_IMAGE_MACHINE_CROSS_TYPE_VALUE)
  #else
#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine)  (FALSE)
  #endif
#endif

#endif




/// The primary GUID Partition Table Header must be
/// located in LBA 1 (i.e., the second logical block).
///
#define PRIMARY_PART_HEADER_LBA  1
///
/// EFI Partition Table Signature: "EFI PART".
///
#define EFI_PTAB_HEADER_ID  SIGNATURE_64 ('E','F','I',' ','P','A','R','T')
///
/// Minimum bytes reserve for EFI entry array buffer.
///
#define EFI_GPT_PART_ENTRY_MIN_SIZE  16384

#pragma pack(1)


  /// The table header for the GPT partition Table.
  /// This header contains EFI_PTAB_HEADER_ID.
  ///
  EFI_TABLE_HEADER    Header;
  ///
  /// The LBA that contains this data structure.
  ///
  EFI_LBA             MyLBA;
  ///
  /// LBA address of the alternate GUID Partition Table Header.
  ///
  EFI_LBA             AlternateLBA;
  ///
  /// The first usable logical block that may be used
  /// by a partition described by a GUID Partition Entry.
  ///
  EFI_LBA             FirstUsableLBA;
  ///
  /// The last usable logical block that may be used
  /// by a partition described by a GUID Partition Entry.
  ///
  EFI_LBA             LastUsableLBA;
  ///
  /// GUID that can be used to uniquely identify the disk.
  ///
  EFI_GUID            DiskGUID;
  ///
  /// The starting LBA of the GUID Partition Entry array.
  ///
  EFI_LBA             PartitionEntryLBA;
  ///
  /// The number of Partition Entries in the GUID Partition Entry array.
  ///
  UINT32              NumberOfPartitionEntries;
  ///
  /// The size, in bytes, of each the GUID Partition
  /// Entry structures in the GUID Partition Entry
  /// array. This field shall be set to a value of 128 x 2^n where n is
  /// an integer greater than or equal to zero (e.g., 128, 256, 512, etc.).
  ///
  UINT32              SizeOfPartitionEntry;
  ///
  /// The CRC32 of the GUID Partition Entry array.
  /// Starts at PartitionEntryLBA and is
  /// computed over a byte length of
  /// NumberOfPartitionEntries * SizeOfPartitionEntry.
  ///
  UINT32              PartitionEntryArrayCRC32;
} EFI_PARTITION_TABLE_HEADER;

///

  /// Unique ID that defines the purpose and type of this Partition. A value of
  /// zero defines that this partition entry is not being used.
  ///
  EFI_GUID    PartitionTypeGUID;
  ///
  /// GUID that is unique for every partition entry. Every partition ever
  /// created will have a unique GUID.
  /// This GUID must be assigned when the GUID Partition Entry is created.
  ///
  EFI_GUID    UniquePartitionGUID;
  ///
  /// Starting LBA of the partition defined by this entry
  ///
  EFI_LBA     StartingLBA;
  ///
  /// Ending LBA of the partition defined by this entry.
  ///
  EFI_LBA     EndingLBA;
  ///
  /// Attribute bits, all bits reserved by UEFI
  /// Bit 0:      If this bit is set, the partition is required for the platform to function. The owner/creator of the


#pragma pack()
#endif






///
/// The following types are currently defined:
///
typedef VOID    *EFI_HII_HANDLE;
typedef CHAR16  *EFI_STRING;
typedef UINT16  EFI_IMAGE_ID;
typedef UINT16  EFI_QUESTION_ID;
typedef UINT16  EFI_STRING_ID;

typedef UINT16  EFI_VARSTORE_ID;
typedef UINT16  EFI_ANIMATION_ID;

typedef UINT16 EFI_DEFAULT_ID;

typedef UINT32  EFI_HII_FONT_STYLE;


typedef UINT32 EFI_HII_FONT_STYLE;

#pragma pack(1)


/// The header found at the start of each package list.
///
typedef struct {
  EFI_GUID    PackageListGuid;
  UINT32      PackageLength;
} EFI_HII_PACKAGE_LIST_HEADER;

///
/// The header found at the start of each package.
///
typedef struct {
  UINT32    Length : 24;
  UINT32    Type   : 8;
  // UINT8  Data[...];
} EFI_HII_PACKAGE_HEADER;

//
// Value of HII package type
//
#define EFI_HII_PACKAGE_TYPE_ALL           0x00
#define EFI_HII_PACKAGE_TYPE_GUID          0x01
#define EFI_HII_PACKAGE_FORMS              0x02
#define EFI_HII_PACKAGE_STRINGS            0x04
#define EFI_HII_PACKAGE_FONTS              0x05
#define EFI_HII_PACKAGE_IMAGES             0x06
#define EFI_HII_PACKAGE_SIMPLE_FONTS       0x07
#define EFI_HII_PACKAGE_DEVICE_PATH        0x08
#define EFI_HII_PACKAGE_KEYBOARD_LAYOUT    0x09
#define EFI_HII_PACKAGE_ANIMATIONS         0x0A
#define EFI_HII_PACKAGE_END                0xDF
#define EFI_HII_PACKAGE_TYPE_SYSTEM_BEGIN  0xE0
#define EFI_HII_PACKAGE_TYPE_SYSTEM_END    0xFF

//
// Definitions for Simplified Font Package

///
/// Contents of EFI_NARROW_GLYPH.Attributes.
///@{
#define EFI_GLYPH_NON_SPACING  0x01
#define EFI_GLYPH_WIDE         0x02
#define EFI_GLYPH_HEIGHT       19
#define EFI_GLYPH_WIDTH        8
///@}

///

  /// The Unicode representation of the glyph. The term weight is the
  /// technical term for a character code.
  ///
  CHAR16    UnicodeWeight;
  ///
  /// The data element containing the glyph definitions.
  ///
  UINT8     Attributes;
  ///
  /// The column major glyph representation of the character. Bits
  /// with values of one indicate that the corresponding pixel is to be
  /// on when normally displayed; those with zero are off.
  ///
  UINT8     GlyphCol1[EFI_GLYPH_HEIGHT];
} EFI_NARROW_GLYPH;

///

  /// The Unicode representation of the glyph. The term weight is the
  /// technical term for a character code.
  ///
  CHAR16    UnicodeWeight;
  ///
  /// The data element containing the glyph definitions.
  ///
  UINT8     Attributes;
  ///
  /// The column major glyph representation of the character. Bits
  /// with values of one indicate that the corresponding pixel is to be
  /// on when normally displayed; those with zero are off.
  ///
  UINT8     GlyphCol1[EFI_GLYPH_HEIGHT];
  ///
  /// The column major glyph representation of the character. Bits
  /// with values of one indicate that the corresponding pixel is to be
  /// on when normally displayed; those with zero are off.
  ///
  UINT8     GlyphCol2[EFI_GLYPH_HEIGHT];
  ///
  /// Ensures that sizeof (EFI_WIDE_GLYPH) is twice the
  /// sizeof (EFI_NARROW_GLYPH). The contents of Pad must
  /// be zero.
  ///
  UINT8     Pad[3];
} EFI_WIDE_GLYPH;

///

/// followed by a series of glyph structures.
///
typedef struct _EFI_HII_SIMPLE_FONT_PACKAGE_HDR {
  EFI_HII_PACKAGE_HEADER    Header;
  UINT16                    NumberOfNarrowGlyphs;
  UINT16                    NumberOfWideGlyphs;
  // EFI_NARROW_GLYPH       NarrowGlyphs[];
  // EFI_WIDE_GLYPH         WideGlyphs[];
} EFI_HII_SIMPLE_FONT_PACKAGE_HDR;

//
// Value for font style
//
#define EFI_HII_FONT_STYLE_NORMAL     0x00000000
#define EFI_HII_FONT_STYLE_BOLD       0x00000001
#define EFI_HII_FONT_STYLE_ITALIC     0x00000002
#define EFI_HII_FONT_STYLE_EMBOSS     0x00010000
#define EFI_HII_FONT_STYLE_OUTLINE    0x00020000
#define EFI_HII_FONT_STYLE_SHADOW     0x00040000
#define EFI_HII_FONT_STYLE_UNDERLINE  0x00080000
#define EFI_HII_FONT_STYLE_DBL_UNDER  0x00100000

typedef struct _EFI_HII_GLYPH_INFO {
  UINT16    Width;
  UINT16    Height;
  INT16     OffsetX;
  INT16     OffsetY;
  INT16     AdvanceX;
} EFI_HII_GLYPH_INFO;

///

/// information, the glyph bitmaps and the character map.
///
typedef struct _EFI_HII_FONT_PACKAGE_HDR {
  EFI_HII_PACKAGE_HEADER    Header;
  UINT32                    HdrSize;
  UINT32                    GlyphBlockOffset;
  EFI_HII_GLYPH_INFO        Cell;
  EFI_HII_FONT_STYLE        FontStyle;
  CHAR16                    FontFamily[1];
} EFI_HII_FONT_PACKAGE_HDR;

//
// Value of different glyph info block types
//
#define EFI_HII_GIBT_END                0x00
#define EFI_HII_GIBT_GLYPH              0x10
#define EFI_HII_GIBT_GLYPHS             0x11
#define EFI_HII_GIBT_GLYPH_DEFAULT      0x12
#define EFI_HII_GIBT_GLYPHS_DEFAULT     0x13
#define EFI_HII_GIBT_GLYPH_VARIABILITY  0x14
#define EFI_HII_GIBT_DUPLICATE          0x20
#define EFI_HII_GIBT_SKIP2              0x21
#define EFI_HII_GIBT_SKIP1              0x22
#define EFI_HII_GIBT_DEFAULTS           0x23
#define EFI_HII_GIBT_EXT1               0x30
#define EFI_HII_GIBT_EXT2               0x31
#define EFI_HII_GIBT_EXT4               0x32

typedef struct _EFI_HII_GLYPH_BLOCK {
  UINT8    BlockType;
} EFI_HII_GLYPH_BLOCK;

//

  EFI_HII_GLYPH_BLOCK    Header;
  EFI_HII_GLYPH_INFO     Cell;
  UINT8                  GlyphPackInBits;
  UINT8                  BitmapData[1];
} EFI_HII_GIBT_VARIABILITY_BLOCK;

typedef struct _EFI_HII_GIBT_SKIP1_BLOCK {

/// associated with the package list.
///
typedef struct _EFI_HII_DEVICE_PATH_PACKAGE_HDR {
  EFI_HII_PACKAGE_HEADER    Header;
  // EFI_DEVICE_PATH_PROTOCOL DevicePath[];
} EFI_HII_DEVICE_PATH_PACKAGE_HDR;


/// The GUID package is used to carry data where the format is defined by a GUID.
///
typedef struct _EFI_HII_GUID_PACKAGE_HDR {
  EFI_HII_PACKAGE_HEADER    Header;
  EFI_GUID                  Guid;
  // Data per GUID definition may follow
} EFI_HII_GUID_PACKAGE_HDR;


// Section 27.3.6
//

#define UEFI_CONFIG_LANG    "x-UEFI"
#define UEFI_CONFIG_LANG_2  "x-i-UEFI"

///
/// The fixed header consists of a standard record header and then the string identifiers
/// contained in this section and the offsets of the string and language information.
///
typedef struct _EFI_HII_STRING_PACKAGE_HDR {
  EFI_HII_PACKAGE_HEADER    Header;
  UINT32                    HdrSize;
  UINT32                    StringInfoOffset;
  CHAR16                    LanguageWindow[16];
  EFI_STRING_ID             LanguageName;
  CHAR8                     Language[1];
} EFI_HII_STRING_PACKAGE_HDR;

typedef struct {
  UINT8    BlockType;
} EFI_HII_STRING_BLOCK;

//
// Value of different string information block types
//
#define EFI_HII_SIBT_END                0x00
#define EFI_HII_SIBT_STRING_SCSU        0x10
#define EFI_HII_SIBT_STRING_SCSU_FONT   0x11
#define EFI_HII_SIBT_STRINGS_SCSU       0x12
#define EFI_HII_SIBT_STRINGS_SCSU_FONT  0x13
#define EFI_HII_SIBT_STRING_UCS2        0x14
#define EFI_HII_SIBT_STRING_UCS2_FONT   0x15
#define EFI_HII_SIBT_STRINGS_UCS2       0x16
#define EFI_HII_SIBT_STRINGS_UCS2_FONT  0x17
#define EFI_HII_SIBT_DUPLICATE          0x20
#define EFI_HII_SIBT_SKIP2              0x21
#define EFI_HII_SIBT_SKIP1              0x22
#define EFI_HII_SIBT_EXT1               0x30
#define EFI_HII_SIBT_EXT2               0x31
#define EFI_HII_SIBT_EXT4               0x32
#define EFI_HII_SIBT_FONT               0x40

//
// Definition of different string information block types

} EFI_HII_SIBT_EXT4_BLOCK;

typedef struct _EFI_HII_SIBT_FONT_BLOCK {
  EFI_HII_SIBT_EXT2_BLOCK    Header;
  UINT8                      FontId;
  UINT16                     FontSize;
  EFI_HII_FONT_STYLE         FontStyle;
  CHAR16                     FontName[1];
} EFI_HII_SIBT_FONT_BLOCK;

typedef struct _EFI_HII_SIBT_SKIP1_BLOCK {

//

typedef struct _EFI_HII_IMAGE_PACKAGE_HDR {
  EFI_HII_PACKAGE_HEADER    Header;
  UINT32                    ImageInfoOffset;
  UINT32                    PaletteInfoOffset;
} EFI_HII_IMAGE_PACKAGE_HDR;

typedef struct _EFI_HII_IMAGE_BLOCK {
  UINT8    BlockType;
} EFI_HII_IMAGE_BLOCK;

//
// Value of different image information block types
//
#define EFI_HII_IIBT_END                0x00
#define EFI_HII_IIBT_IMAGE_1BIT         0x10
#define EFI_HII_IIBT_IMAGE_1BIT_TRANS   0x11
#define EFI_HII_IIBT_IMAGE_4BIT         0x12
#define EFI_HII_IIBT_IMAGE_4BIT_TRANS   0x13
#define EFI_HII_IIBT_IMAGE_8BIT         0x14
#define EFI_HII_IIBT_IMAGE_8BIT_TRANS   0x15
#define EFI_HII_IIBT_IMAGE_24BIT        0x16
#define EFI_HII_IIBT_IMAGE_24BIT_TRANS  0x17
#define EFI_HII_IIBT_IMAGE_JPEG         0x18
#define EFI_HII_IIBT_IMAGE_PNG          0x19
#define EFI_HII_IIBT_DUPLICATE          0x20
#define EFI_HII_IIBT_SKIP2              0x21
#define EFI_HII_IIBT_SKIP1              0x22
#define EFI_HII_IIBT_EXT1               0x30
#define EFI_HII_IIBT_EXT2               0x31
#define EFI_HII_IIBT_EXT4               0x32

//
// Definition of different image information block types
//

typedef struct _EFI_HII_IIBT_END_BLOCK {
  EFI_HII_IMAGE_BLOCK    Header;
} EFI_HII_IIBT_END_BLOCK;

typedef struct _EFI_HII_IIBT_EXT1_BLOCK {
  EFI_HII_IMAGE_BLOCK    Header;
  UINT8                  BlockType2;
  UINT8                  Length;
} EFI_HII_IIBT_EXT1_BLOCK;

typedef struct _EFI_HII_IIBT_EXT2_BLOCK {
  EFI_HII_IMAGE_BLOCK    Header;
  UINT8                  BlockType2;
  UINT16                 Length;
} EFI_HII_IIBT_EXT2_BLOCK;

typedef struct _EFI_HII_IIBT_EXT4_BLOCK {
  EFI_HII_IMAGE_BLOCK    Header;
  UINT8                  BlockType2;
  UINT32                 Length;
} EFI_HII_IIBT_EXT4_BLOCK;

typedef struct _EFI_HII_IIBT_IMAGE_1BIT_BASE {
  UINT16    Width;
  UINT16    Height;
  UINT8     Data[1];
} EFI_HII_IIBT_IMAGE_1BIT_BASE;

typedef struct _EFI_HII_IIBT_IMAGE_1BIT_BLOCK {
  EFI_HII_IMAGE_BLOCK             Header;
  UINT8                           PaletteIndex;
  EFI_HII_IIBT_IMAGE_1BIT_BASE    Bitmap;
} EFI_HII_IIBT_IMAGE_1BIT_BLOCK;

typedef struct _EFI_HII_IIBT_IMAGE_1BIT_TRANS_BLOCK {
  EFI_HII_IMAGE_BLOCK             Header;
  UINT8                           PaletteIndex;
  EFI_HII_IIBT_IMAGE_1BIT_BASE    Bitmap;
} EFI_HII_IIBT_IMAGE_1BIT_TRANS_BLOCK;

typedef struct _EFI_HII_RGB_PIXEL {
  UINT8    b;
  UINT8    g;
  UINT8    r;
} EFI_HII_RGB_PIXEL;

typedef struct _EFI_HII_IIBT_IMAGE_24BIT_BASE {
  UINT16               Width;
  UINT16               Height;
  EFI_HII_RGB_PIXEL    Bitmap[1];
} EFI_HII_IIBT_IMAGE_24BIT_BASE;

typedef struct _EFI_HII_IIBT_IMAGE_24BIT_BLOCK {
  EFI_HII_IMAGE_BLOCK              Header;
  EFI_HII_IIBT_IMAGE_24BIT_BASE    Bitmap;
} EFI_HII_IIBT_IMAGE_24BIT_BLOCK;

typedef struct _EFI_HII_IIBT_IMAGE_24BIT_TRANS_BLOCK {
  EFI_HII_IMAGE_BLOCK              Header;
  EFI_HII_IIBT_IMAGE_24BIT_BASE    Bitmap;
} EFI_HII_IIBT_IMAGE_24BIT_TRANS_BLOCK;

typedef struct _EFI_HII_IIBT_IMAGE_4BIT_BASE {
  UINT16    Width;
  UINT16    Height;
  UINT8     Data[1];
} EFI_HII_IIBT_IMAGE_4BIT_BASE;

typedef struct _EFI_HII_IIBT_IMAGE_4BIT_BLOCK {
  EFI_HII_IMAGE_BLOCK             Header;
  UINT8                           PaletteIndex;
  EFI_HII_IIBT_IMAGE_4BIT_BASE    Bitmap;
} EFI_HII_IIBT_IMAGE_4BIT_BLOCK;

typedef struct _EFI_HII_IIBT_IMAGE_4BIT_TRANS_BLOCK {
  EFI_HII_IMAGE_BLOCK             Header;
  UINT8                           PaletteIndex;
  EFI_HII_IIBT_IMAGE_4BIT_BASE    Bitmap;
} EFI_HII_IIBT_IMAGE_4BIT_TRANS_BLOCK;

typedef struct _EFI_HII_IIBT_IMAGE_8BIT_BASE {
  UINT16    Width;
  UINT16    Height;
  UINT8     Data[1];
} EFI_HII_IIBT_IMAGE_8BIT_BASE;

typedef struct _EFI_HII_IIBT_IMAGE_8BIT_PALETTE_BLOCK {
  EFI_HII_IMAGE_BLOCK             Header;
  UINT8                           PaletteIndex;
  EFI_HII_IIBT_IMAGE_8BIT_BASE    Bitmap;
} EFI_HII_IIBT_IMAGE_8BIT_BLOCK;

typedef struct _EFI_HII_IIBT_IMAGE_8BIT_TRANS_BLOCK {
  EFI_HII_IMAGE_BLOCK             Header;
  UINT8                           PaletteIndex;
  EFI_HII_IIBT_IMAGE_8BIT_BASE    Bitmap;
} EFI_HII_IIBT_IMAGE_8BIT_TRAN_BLOCK;

typedef struct _EFI_HII_IIBT_DUPLICATE_BLOCK {
  EFI_HII_IMAGE_BLOCK    Header;
  EFI_IMAGE_ID           ImageId;
} EFI_HII_IIBT_DUPLICATE_BLOCK;

typedef struct _EFI_HII_IIBT_JPEG_BLOCK {
  EFI_HII_IMAGE_BLOCK    Header;
  UINT32                 Size;
  UINT8                  Data[1];
} EFI_HII_IIBT_JPEG_BLOCK;

typedef struct _EFI_HII_IIBT_PNG_BLOCK {
  EFI_HII_IMAGE_BLOCK    Header;
  UINT32                 Size;
  UINT8                  Data[1];
} EFI_HII_IIBT_PNG_BLOCK;

typedef struct _EFI_HII_IIBT_SKIP1_BLOCK {
  EFI_HII_IMAGE_BLOCK    Header;
  UINT8                  SkipCount;
} EFI_HII_IIBT_SKIP1_BLOCK;

typedef struct _EFI_HII_IIBT_SKIP2_BLOCK {
  EFI_HII_IMAGE_BLOCK    Header;
  UINT16                 SkipCount;
} EFI_HII_IIBT_SKIP2_BLOCK;

//

//

typedef struct _EFI_HII_IMAGE_PALETTE_INFO_HEADER {
  UINT16    PaletteCount;
} EFI_HII_IMAGE_PALETTE_INFO_HEADER;

typedef struct _EFI_HII_IMAGE_PALETTE_INFO {
  UINT16               PaletteSize;
  EFI_HII_RGB_PIXEL    PaletteValue[1];
} EFI_HII_IMAGE_PALETTE_INFO;

//

/// The Form package is used to carry form-based encoding data.
///
typedef struct _EFI_HII_FORM_PACKAGE_HDR {
  EFI_HII_PACKAGE_HEADER    Header;
  // EFI_IFR_OP_HEADER         OpCodeHeader;
  // More op-codes follow
} EFI_HII_FORM_PACKAGE_HDR;

typedef struct {
  UINT8    Hour;
  UINT8    Minute;
  UINT8    Second;
} EFI_HII_TIME;

typedef struct {
  UINT16    Year;
  UINT8     Month;
  UINT8     Day;
} EFI_HII_DATE;

typedef struct {
  EFI_QUESTION_ID    QuestionId;
  EFI_FORM_ID        FormId;
  EFI_GUID           FormSetGuid;
  EFI_STRING_ID      DevicePath;
} EFI_HII_REF;

typedef union {
  UINT8            u8;
  UINT16           u16;
  UINT32           u32;
  UINT64           u64;
  BOOLEAN          b;
  EFI_HII_TIME     time;
  EFI_HII_DATE     date;
  EFI_STRING_ID    string; ///< EFI_IFR_TYPE_STRING, EFI_IFR_TYPE_ACTION
  EFI_HII_REF      ref;    ///< EFI_IFR_TYPE_REF
  // UINT8 buffer[];      ///< EFI_IFR_TYPE_BUFFER
} EFI_IFR_TYPE_VALUE;

//
// IFR Opcodes
//
#define EFI_IFR_FORM_OP                 0x01
#define EFI_IFR_SUBTITLE_OP             0x02
#define EFI_IFR_TEXT_OP                 0x03
#define EFI_IFR_IMAGE_OP                0x04
#define EFI_IFR_ONE_OF_OP               0x05
#define EFI_IFR_CHECKBOX_OP             0x06
#define EFI_IFR_NUMERIC_OP              0x07
#define EFI_IFR_PASSWORD_OP             0x08
#define EFI_IFR_ONE_OF_OPTION_OP        0x09
#define EFI_IFR_SUPPRESS_IF_OP          0x0A
#define EFI_IFR_LOCKED_OP               0x0B
#define EFI_IFR_ACTION_OP               0x0C
#define EFI_IFR_RESET_BUTTON_OP         0x0D
#define EFI_IFR_FORM_SET_OP             0x0E
#define EFI_IFR_REF_OP                  0x0F
#define EFI_IFR_NO_SUBMIT_IF_OP         0x10
#define EFI_IFR_INCONSISTENT_IF_OP      0x11
#define EFI_IFR_EQ_ID_VAL_OP            0x12
#define EFI_IFR_EQ_ID_ID_OP             0x13
#define EFI_IFR_EQ_ID_VAL_LIST_OP       0x14
#define EFI_IFR_AND_OP                  0x15
#define EFI_IFR_OR_OP                   0x16
#define EFI_IFR_NOT_OP                  0x17
#define EFI_IFR_RULE_OP                 0x18
#define EFI_IFR_GRAY_OUT_IF_OP          0x19
#define EFI_IFR_DATE_OP                 0x1A
#define EFI_IFR_TIME_OP                 0x1B
#define EFI_IFR_STRING_OP               0x1C
#define EFI_IFR_REFRESH_OP              0x1D
#define EFI_IFR_DISABLE_IF_OP           0x1E
#define EFI_IFR_ANIMATION_OP            0x1F
#define EFI_IFR_TO_LOWER_OP             0x20
#define EFI_IFR_TO_UPPER_OP             0x21
#define EFI_IFR_MAP_OP                  0x22
#define EFI_IFR_ORDERED_LIST_OP         0x23
#define EFI_IFR_VARSTORE_OP             0x24
#define EFI_IFR_VARSTORE_NAME_VALUE_OP  0x25
#define EFI_IFR_VARSTORE_EFI_OP         0x26
#define EFI_IFR_VARSTORE_DEVICE_OP      0x27
#define EFI_IFR_VERSION_OP              0x28
#define EFI_IFR_END_OP                  0x29
#define EFI_IFR_MATCH_OP                0x2A
#define EFI_IFR_GET_OP                  0x2B
#define EFI_IFR_SET_OP                  0x2C
#define EFI_IFR_READ_OP                 0x2D
#define EFI_IFR_WRITE_OP                0x2E
#define EFI_IFR_EQUAL_OP                0x2F
#define EFI_IFR_NOT_EQUAL_OP            0x30
#define EFI_IFR_GREATER_THAN_OP         0x31
#define EFI_IFR_GREATER_EQUAL_OP        0x32
#define EFI_IFR_LESS_THAN_OP            0x33
#define EFI_IFR_LESS_EQUAL_OP           0x34
#define EFI_IFR_BITWISE_AND_OP          0x35
#define EFI_IFR_BITWISE_OR_OP           0x36
#define EFI_IFR_BITWISE_NOT_OP          0x37
#define EFI_IFR_SHIFT_LEFT_OP           0x38
#define EFI_IFR_SHIFT_RIGHT_OP          0x39
#define EFI_IFR_ADD_OP                  0x3A
#define EFI_IFR_SUBTRACT_OP             0x3B
#define EFI_IFR_MULTIPLY_OP             0x3C
#define EFI_IFR_DIVIDE_OP               0x3D
#define EFI_IFR_MODULO_OP               0x3E
#define EFI_IFR_RULE_REF_OP             0x3F
#define EFI_IFR_QUESTION_REF1_OP        0x40
#define EFI_IFR_QUESTION_REF2_OP        0x41
#define EFI_IFR_UINT8_OP                0x42
#define EFI_IFR_UINT16_OP               0x43
#define EFI_IFR_UINT32_OP               0x44
#define EFI_IFR_UINT64_OP               0x45
#define EFI_IFR_TRUE_OP                 0x46
#define EFI_IFR_FALSE_OP                0x47
#define EFI_IFR_TO_UINT_OP              0x48
#define EFI_IFR_TO_STRING_OP            0x49
#define EFI_IFR_TO_BOOLEAN_OP           0x4A
#define EFI_IFR_MID_OP                  0x4B
#define EFI_IFR_FIND_OP                 0x4C
#define EFI_IFR_TOKEN_OP                0x4D
#define EFI_IFR_STRING_REF1_OP          0x4E
#define EFI_IFR_STRING_REF2_OP          0x4F
#define EFI_IFR_CONDITIONAL_OP          0x50
#define EFI_IFR_QUESTION_REF3_OP        0x51
#define EFI_IFR_ZERO_OP                 0x52
#define EFI_IFR_ONE_OP                  0x53
#define EFI_IFR_ONES_OP                 0x54
#define EFI_IFR_UNDEFINED_OP            0x55
#define EFI_IFR_LENGTH_OP               0x56
#define EFI_IFR_DUP_OP                  0x57
#define EFI_IFR_THIS_OP                 0x58
#define EFI_IFR_SPAN_OP                 0x59
#define EFI_IFR_VALUE_OP                0x5A
#define EFI_IFR_DEFAULT_OP              0x5B
#define EFI_IFR_DEFAULTSTORE_OP         0x5C
#define EFI_IFR_FORM_MAP_OP             0x5D
#define EFI_IFR_CATENATE_OP             0x5E
#define EFI_IFR_GUID_OP                 0x5F
#define EFI_IFR_SECURITY_OP             0x60
#define EFI_IFR_MODAL_TAG_OP            0x61
#define EFI_IFR_REFRESH_ID_OP           0x62
#define EFI_IFR_WARNING_IF_OP           0x63
#define EFI_IFR_MATCH2_OP               0x64

//
// Definitions of IFR Standard Headers

//

typedef struct _EFI_IFR_OP_HEADER {
  UINT8    OpCode;
  UINT8    Length : 7;
  UINT8    Scope  : 1;
} EFI_IFR_OP_HEADER;

typedef struct _EFI_IFR_STATEMENT_HEADER {
  EFI_STRING_ID    Prompt;
  EFI_STRING_ID    Help;
} EFI_IFR_STATEMENT_HEADER;

typedef struct _EFI_IFR_QUESTION_HEADER {
  EFI_IFR_STATEMENT_HEADER    Header;
  EFI_QUESTION_ID             QuestionId;
  EFI_VARSTORE_ID             VarStoreId;
  union {
    EFI_STRING_ID    VarName;
    UINT16           VarOffset;
  }                        VarStoreInfo;
  UINT8                       Flags;
} EFI_IFR_QUESTION_HEADER;

//
// Flag values of EFI_IFR_QUESTION_HEADER
//
#define EFI_IFR_FLAG_READ_ONLY           0x01
#define EFI_IFR_FLAG_CALLBACK            0x04
#define EFI_IFR_FLAG_RESET_REQUIRED      0x10
#define EFI_IFR_FLAG_REST_STYLE          0x20
#define EFI_IFR_FLAG_RECONNECT_REQUIRED  0x40
#define EFI_IFR_FLAG_OPTIONS_ONLY        0x80

//
// Definition for Opcode Reference
// Section 27.3.8.3
//
typedef struct _EFI_IFR_DEFAULTSTORE {
  EFI_IFR_OP_HEADER    Header;
  EFI_STRING_ID        DefaultName;
  UINT16               DefaultId;
} EFI_IFR_DEFAULTSTORE;

//
// Default Identifier of default store
//
#define EFI_HII_DEFAULT_CLASS_STANDARD        0x0000
#define EFI_HII_DEFAULT_CLASS_MANUFACTURING   0x0001
#define EFI_HII_DEFAULT_CLASS_SAFE            0x0002
#define EFI_HII_DEFAULT_CLASS_PLATFORM_BEGIN  0x4000
#define EFI_HII_DEFAULT_CLASS_PLATFORM_END    0x7fff
#define EFI_HII_DEFAULT_CLASS_HARDWARE_BEGIN  0x8000
#define EFI_HII_DEFAULT_CLASS_HARDWARE_END    0xbfff
#define EFI_HII_DEFAULT_CLASS_FIRMWARE_BEGIN  0xc000
#define EFI_HII_DEFAULT_CLASS_FIRMWARE_END    0xffff

typedef struct _EFI_IFR_VARSTORE {
  EFI_IFR_OP_HEADER    Header;
  EFI_GUID             Guid;
  EFI_VARSTORE_ID      VarStoreId;
  UINT16               Size;
  UINT8                Name[1];
} EFI_IFR_VARSTORE;

typedef struct _EFI_IFR_VARSTORE_EFI {
  EFI_IFR_OP_HEADER    Header;
  EFI_VARSTORE_ID      VarStoreId;
  EFI_GUID             Guid;
  UINT32               Attributes;
  UINT16               Size;
  UINT8                Name[1];
} EFI_IFR_VARSTORE_EFI;

typedef struct _EFI_IFR_VARSTORE_NAME_VALUE {
  EFI_IFR_OP_HEADER    Header;
  EFI_VARSTORE_ID      VarStoreId;
  EFI_GUID             Guid;
} EFI_IFR_VARSTORE_NAME_VALUE;

typedef struct _EFI_IFR_FORM_SET {
  EFI_IFR_OP_HEADER    Header;
  EFI_GUID             Guid;
  EFI_STRING_ID        FormSetTitle;
  EFI_STRING_ID        Help;
  UINT8                Flags;
  // EFI_GUID              ClassGuid[];
} EFI_IFR_FORM_SET;

typedef struct _EFI_IFR_END {
  EFI_IFR_OP_HEADER    Header;
} EFI_IFR_END;

typedef struct _EFI_IFR_FORM {
  EFI_IFR_OP_HEADER    Header;
  UINT16               FormId;
  EFI_STRING_ID        FormTitle;
} EFI_IFR_FORM;

typedef struct _EFI_IFR_IMAGE {
  EFI_IFR_OP_HEADER    Header;
  EFI_IMAGE_ID         Id;
} EFI_IFR_IMAGE;

typedef struct _EFI_IFR_MODAL_TAG {
  EFI_IFR_OP_HEADER    Header;
} EFI_IFR_MODAL_TAG;

typedef struct _EFI_IFR_LOCKED {
  EFI_IFR_OP_HEADER    Header;
} EFI_IFR_LOCKED;

typedef struct _EFI_IFR_RULE {
  EFI_IFR_OP_HEADER    Header;
  UINT8                RuleId;
} EFI_IFR_RULE;

typedef struct _EFI_IFR_DEFAULT {
  EFI_IFR_OP_HEADER     Header;
  UINT16                DefaultId;
  UINT8                 Type;
  EFI_IFR_TYPE_VALUE    Value;
} EFI_IFR_DEFAULT;

typedef struct _EFI_IFR_DEFAULT_2 {
  EFI_IFR_OP_HEADER    Header;
  UINT16               DefaultId;
  UINT8                Type;
} EFI_IFR_DEFAULT_2;

typedef struct _EFI_IFR_VALUE {
  EFI_IFR_OP_HEADER    Header;
} EFI_IFR_VALUE;

typedef struct _EFI_IFR_SUBTITLE {
  EFI_IFR_OP_HEADER           Header;
  EFI_IFR_STATEMENT_HEADER    Statement;
  UINT8                       Flags;
} EFI_IFR_SUBTITLE;

#define EFI_IFR_FLAGS_HORIZONTAL  0x01

typedef struct _EFI_IFR_CHECKBOX {
  EFI_IFR_OP_HEADER          Header;
  EFI_IFR_QUESTION_HEADER    Question;
  UINT8                      Flags;
} EFI_IFR_CHECKBOX;

#define EFI_IFR_CHECKBOX_DEFAULT      0x01
#define EFI_IFR_CHECKBOX_DEFAULT_MFG  0x02

typedef struct _EFI_IFR_TEXT {
  EFI_IFR_OP_HEADER           Header;
  EFI_IFR_STATEMENT_HEADER    Statement;
  EFI_STRING_ID               TextTwo;
} EFI_IFR_TEXT;

typedef struct _EFI_IFR_REF {
  EFI_IFR_OP_HEADER          Header;
  EFI_IFR_QUESTION_HEADER    Question;
  EFI_FORM_ID                FormId;
} EFI_IFR_REF;

typedef struct _EFI_IFR_REF2 {
  EFI_IFR_OP_HEADER          Header;
  EFI_IFR_QUESTION_HEADER    Question;
  EFI_FORM_ID                FormId;
  EFI_QUESTION_ID            QuestionId;
} EFI_IFR_REF2;

typedef struct _EFI_IFR_REF3 {
  EFI_IFR_OP_HEADER          Header;
  EFI_IFR_QUESTION_HEADER    Question;
  EFI_FORM_ID                FormId;
  EFI_QUESTION_ID            QuestionId;
  EFI_GUID                   FormSetId;
} EFI_IFR_REF3;

typedef struct _EFI_IFR_REF4 {
  EFI_IFR_OP_HEADER          Header;
  EFI_IFR_QUESTION_HEADER    Question;
  EFI_FORM_ID                FormId;
  EFI_QUESTION_ID            QuestionId;
  EFI_GUID                   FormSetId;
  EFI_STRING_ID              DevicePath;
} EFI_IFR_REF4;

typedef struct _EFI_IFR_REF5 {
  EFI_IFR_OP_HEADER          Header;
  EFI_IFR_QUESTION_HEADER    Question;
} EFI_IFR_REF5;

typedef struct _EFI_IFR_RESET_BUTTON {
  EFI_IFR_OP_HEADER           Header;
  EFI_IFR_STATEMENT_HEADER    Statement;
  EFI_DEFAULT_ID              DefaultId;
} EFI_IFR_RESET_BUTTON;

typedef struct _EFI_IFR_ACTION {
  EFI_IFR_OP_HEADER          Header;
  EFI_IFR_QUESTION_HEADER    Question;
  EFI_STRING_ID              QuestionConfig;
} EFI_IFR_ACTION;

typedef struct _EFI_IFR_ACTION_1 {
  EFI_IFR_OP_HEADER          Header;
  EFI_IFR_QUESTION_HEADER    Question;
} EFI_IFR_ACTION_1;

typedef struct _EFI_IFR_DATE {
  EFI_IFR_OP_HEADER          Header;
  EFI_IFR_QUESTION_HEADER    Question;
  UINT8                      Flags;
} EFI_IFR_DATE;

//
// Flags that describe the behavior of the question.
//
#define EFI_QF_DATE_YEAR_SUPPRESS   0x01
#define EFI_QF_DATE_MONTH_SUPPRESS  0x02
#define EFI_QF_DATE_DAY_SUPPRESS    0x04

#define EFI_QF_DATE_STORAGE         0x30
#define     QF_DATE_STORAGE_NORMAL  0x00
#define     QF_DATE_STORAGE_TIME    0x10
#define     QF_DATE_STORAGE_WAKEUP  0x20

typedef union {
  struct {
    UINT8    MinValue;
    UINT8    MaxValue;
    UINT8    Step;
  } u8;
  struct {
    UINT16    MinValue;
    UINT16    MaxValue;
    UINT16    Step;
  } u16;
  struct {
    UINT32    MinValue;
    UINT32    MaxValue;
    UINT32    Step;
  } u32;
  struct {
    UINT64    MinValue;
    UINT64    MaxValue;
    UINT64    Step;
  } u64;
} MINMAXSTEP_DATA;

typedef struct _EFI_IFR_NUMERIC {
  EFI_IFR_OP_HEADER          Header;
  EFI_IFR_QUESTION_HEADER    Question;
  UINT8                      Flags;
  MINMAXSTEP_DATA            data;
} EFI_IFR_NUMERIC;

//
// Flags related to the numeric question
//
#define EFI_IFR_NUMERIC_SIZE      0x03
#define   EFI_IFR_NUMERIC_SIZE_1  0x00
#define   EFI_IFR_NUMERIC_SIZE_2  0x01
#define   EFI_IFR_NUMERIC_SIZE_4  0x02
#define   EFI_IFR_NUMERIC_SIZE_8  0x03

#define EFI_IFR_DISPLAY             0x30
#define   EFI_IFR_DISPLAY_INT_DEC   0x00
#define   EFI_IFR_DISPLAY_UINT_DEC  0x10
#define   EFI_IFR_DISPLAY_UINT_HEX  0x20

typedef struct _EFI_IFR_ONE_OF {
  EFI_IFR_OP_HEADER          Header;
  EFI_IFR_QUESTION_HEADER    Question;
  UINT8                      Flags;
  MINMAXSTEP_DATA            data;
} EFI_IFR_ONE_OF;

typedef struct _EFI_IFR_STRING {
  EFI_IFR_OP_HEADER          Header;
  EFI_IFR_QUESTION_HEADER    Question;
  UINT8                      MinSize;
  UINT8                      MaxSize;
  UINT8                      Flags;
} EFI_IFR_STRING;

#define EFI_IFR_STRING_MULTI_LINE  0x01

typedef struct _EFI_IFR_PASSWORD {
  EFI_IFR_OP_HEADER          Header;
  EFI_IFR_QUESTION_HEADER    Question;
  UINT16                     MinSize;
  UINT16                     MaxSize;
} EFI_IFR_PASSWORD;

typedef struct _EFI_IFR_ORDERED_LIST {
  EFI_IFR_OP_HEADER          Header;
  EFI_IFR_QUESTION_HEADER    Question;
  UINT8                      MaxContainers;
  UINT8                      Flags;
} EFI_IFR_ORDERED_LIST;

#define EFI_IFR_UNIQUE_SET    0x01
#define EFI_IFR_NO_EMPTY_SET  0x02

typedef struct _EFI_IFR_TIME {
  EFI_IFR_OP_HEADER          Header;
  EFI_IFR_QUESTION_HEADER    Question;
  UINT8                      Flags;
} EFI_IFR_TIME;

//
// A bit-mask that determines which unique settings are active for this opcode.
//
#define QF_TIME_HOUR_SUPPRESS    0x01
#define QF_TIME_MINUTE_SUPPRESS  0x02
#define QF_TIME_SECOND_SUPPRESS  0x04

#define QF_TIME_STORAGE           0x30
#define   QF_TIME_STORAGE_NORMAL  0x00
#define   QF_TIME_STORAGE_TIME    0x10
#define   QF_TIME_STORAGE_WAKEUP  0x20

typedef struct _EFI_IFR_DISABLE_IF {
  EFI_IFR_OP_HEADER    Header;
} EFI_IFR_DISABLE_IF;

typedef struct _EFI_IFR_SUPPRESS_IF {
  EFI_IFR_OP_HEADER    Header;
} EFI_IFR_SUPPRESS_IF;

typedef struct _EFI_IFR_GRAY_OUT_IF {
  EFI_IFR_OP_HEADER    Header;
} EFI_IFR_GRAY_OUT_IF;

typedef struct _EFI_IFR_INCONSISTENT_IF {
  EFI_IFR_OP_HEADER    Header;
  EFI_STRING_ID        Error;
} EFI_IFR_INCONSISTENT_IF;

typedef struct _EFI_IFR_NO_SUBMIT_IF {
  EFI_IFR_OP_HEADER    Header;
  EFI_STRING_ID        Error;
} EFI_IFR_NO_SUBMIT_IF;

typedef struct _EFI_IFR_WARNING_IF {
  EFI_IFR_OP_HEADER    Header;
  EFI_STRING_ID        Warning;
  UINT8                TimeOut;
} EFI_IFR_WARNING_IF;

typedef struct _EFI_IFR_REFRESH {
  EFI_IFR_OP_HEADER    Header;
  UINT8                RefreshInterval;
} EFI_IFR_REFRESH;

typedef struct _EFI_IFR_VARSTORE_DEVICE {
  EFI_IFR_OP_HEADER    Header;
  EFI_STRING_ID        DevicePath;
} EFI_IFR_VARSTORE_DEVICE;

typedef struct _EFI_IFR_ONE_OF_OPTION {
  EFI_IFR_OP_HEADER     Header;
  EFI_STRING_ID         Option;
  UINT8                 Flags;
  UINT8                 Type;
  EFI_IFR_TYPE_VALUE    Value;
} EFI_IFR_ONE_OF_OPTION;

//
// Types of the option's value.
//
#define EFI_IFR_TYPE_NUM_SIZE_8   0x00
#define EFI_IFR_TYPE_NUM_SIZE_16  0x01
#define EFI_IFR_TYPE_NUM_SIZE_32  0x02
#define EFI_IFR_TYPE_NUM_SIZE_64  0x03
#define EFI_IFR_TYPE_BOOLEAN      0x04
#define EFI_IFR_TYPE_TIME         0x05
#define EFI_IFR_TYPE_DATE         0x06
#define EFI_IFR_TYPE_STRING       0x07
#define EFI_IFR_TYPE_OTHER        0x08
#define EFI_IFR_TYPE_UNDEFINED    0x09
#define EFI_IFR_TYPE_ACTION       0x0A
#define EFI_IFR_TYPE_BUFFER       0x0B
#define EFI_IFR_TYPE_REF          0x0C

#define EFI_IFR_OPTION_DEFAULT      0x10
#define EFI_IFR_OPTION_DEFAULT_MFG  0x20

typedef struct _EFI_IFR_GUID {
  EFI_IFR_OP_HEADER    Header;
  EFI_GUID             Guid;
  // Optional Data Follows
} EFI_IFR_GUID;

typedef struct _EFI_IFR_REFRESH_ID {
  EFI_IFR_OP_HEADER    Header;
  EFI_GUID             RefreshEventGroupId;
} EFI_IFR_REFRESH_ID;

typedef struct _EFI_IFR_DUP {
  EFI_IFR_OP_HEADER    Header;
} EFI_IFR_DUP;

typedef struct _EFI_IFR_EQ_ID_ID {
  EFI_IFR_OP_HEADER    Header;
  EFI_QUESTION_ID      QuestionId1;
  EFI_QUESTION_ID      QuestionId2;
} EFI_IFR_EQ_ID_ID;

typedef struct _EFI_IFR_EQ_ID_VAL {
  EFI_IFR_OP_HEADER    Header;
  EFI_QUESTION_ID      QuestionId;
  UINT16               Value;
} EFI_IFR_EQ_ID_VAL;

typedef struct _EFI_IFR_EQ_ID_VAL_LIST {
  EFI_IFR_OP_HEADER    Header;
  EFI_QUESTION_ID      QuestionId;
  UINT16               ListLength;
  UINT16               ValueList[1];
} EFI_IFR_EQ_ID_VAL_LIST;

typedef struct _EFI_IFR_UINT8 {
  EFI_IFR_OP_HEADER    Header;
  UINT8                Value;
} EFI_IFR_UINT8;

typedef struct _EFI_IFR_UINT16 {
  EFI_IFR_OP_HEADER    Header;
  UINT16               Value;
} EFI_IFR_UINT16;

typedef struct _EFI_IFR_UINT32 {
  EFI_IFR_OP_HEADER    Header;
  UINT32               Value;
} EFI_IFR_UINT32;

typedef struct _EFI_IFR_UINT64 {
  EFI_IFR_OP_HEADER    Header;
  UINT64               Value;
} EFI_IFR_UINT64;

typedef struct _EFI_IFR_QUESTION_REF1 {
  EFI_IFR_OP_HEADER    Header;
  EFI_QUESTION_ID      QuestionId;
} EFI_IFR_QUESTION_REF1;

typedef struct _EFI_IFR_QUESTION_REF2 {
  EFI_IFR_OP_HEADER    Header;
} EFI_IFR_QUESTION_REF2;

typedef struct _EFI_IFR_QUESTION_REF3 {
  EFI_IFR_OP_HEADER    Header;
} EFI_IFR_QUESTION_REF3;

typedef struct _EFI_IFR_QUESTION_REF3_2 {
  EFI_IFR_OP_HEADER    Header;
  EFI_STRING_ID        DevicePath;
} EFI_IFR_QUESTION_REF3_2;

typedef struct _EFI_IFR_QUESTION_REF3_3 {
  EFI_IFR_OP_HEADER    Header;
  EFI_STRING_ID        DevicePath;
  EFI_GUID             Guid;
} EFI_IFR_QUESTION_REF3_3;

typedef struct _EFI_IFR_RULE_REF {
  EFI_IFR_OP_HEADER    Header;
  UINT8                RuleId;
} EFI_IFR_RULE_REF;

typedef struct _EFI_IFR_STRING_REF1 {
  EFI_IFR_OP_HEADER    Header;
  EFI_STRING_ID        StringId;
} EFI_IFR_STRING_REF1;

typedef struct _EFI_IFR_STRING_REF2 {
  EFI_IFR_OP_HEADER    Header;
} EFI_IFR_STRING_REF2;

typedef struct _EFI_IFR_THIS {
  EFI_IFR_OP_HEADER    Header;
} EFI_IFR_THIS;

typedef struct _EFI_IFR_TRUE {
  EFI_IFR_OP_HEADER    Header;
} EFI_IFR_TRUE;

typedef struct _EFI_IFR_FALSE {
  EFI_IFR_OP_HEADER    Header;
} EFI_IFR_FALSE;

typedef struct _EFI_IFR_ONE {
  EFI_IFR_OP_HEADER    Header;
} EFI_IFR_ONE;

typedef struct _EFI_IFR_ONES {
  EFI_IFR_OP_HEADER    Header;
} EFI_IFR_ONES;

typedef struct _EFI_IFR_ZERO {
  EFI_IFR_OP_HEADER    Header;
} EFI_IFR_ZERO;

typedef struct _EFI_IFR_UNDEFINED {
  EFI_IFR_OP_HEADER    Header;
} EFI_IFR_UNDEFINED;

typedef struct _EFI_IFR_VERSION {
  EFI_IFR_OP_HEADER    Header;
} EFI_IFR_VERSION;

typedef struct _EFI_IFR_LENGTH {
  EFI_IFR_OP_HEADER    Header;
} EFI_IFR_LENGTH;

typedef struct _EFI_IFR_NOT {
  EFI_IFR_OP_HEADER    Header;
} EFI_IFR_NOT;

typedef struct _EFI_IFR_BITWISE_NOT {
  EFI_IFR_OP_HEADER    Header;
} EFI_IFR_BITWISE_NOT;

typedef struct _EFI_IFR_TO_BOOLEAN {
  EFI_IFR_OP_HEADER    Header;
} EFI_IFR_TO_BOOLEAN;

///

/// 2 = hexadecimal (lower-case alpha).
/// 3 = hexadecimal (upper-case alpha).
///@{
#define EFI_IFR_STRING_UNSIGNED_DEC   0
#define EFI_IFR_STRING_SIGNED_DEC     1
#define EFI_IFR_STRING_LOWERCASE_HEX  2
#define EFI_IFR_STRING_UPPERCASE_HEX  3
///@}

///

/// 0 = ASCII.
/// 8 = Unicode.
///@{
#define EFI_IFR_STRING_ASCII    0
#define EFI_IFR_STRING_UNICODE  8
///@}

typedef struct _EFI_IFR_TO_STRING {
  EFI_IFR_OP_HEADER    Header;
  UINT8                Format;
} EFI_IFR_TO_STRING;

typedef struct _EFI_IFR_TO_UINT {
  EFI_IFR_OP_HEADER    Header;
} EFI_IFR_TO_UINT;

typedef struct _EFI_IFR_TO_UPPER {
  EFI_IFR_OP_HEADER    Header;
} EFI_IFR_TO_UPPER;

typedef struct _EFI_IFR_TO_LOWER {
  EFI_IFR_OP_HEADER    Header;
} EFI_IFR_TO_LOWER;

typedef struct _EFI_IFR_ADD {
  EFI_IFR_OP_HEADER    Header;
} EFI_IFR_ADD;

typedef struct _EFI_IFR_AND {
  EFI_IFR_OP_HEADER    Header;
} EFI_IFR_AND;

typedef struct _EFI_IFR_BITWISE_AND {
  EFI_IFR_OP_HEADER    Header;
} EFI_IFR_BITWISE_AND;

typedef struct _EFI_IFR_BITWISE_OR {
  EFI_IFR_OP_HEADER    Header;
} EFI_IFR_BITWISE_OR;

typedef struct _EFI_IFR_CATENATE {
  EFI_IFR_OP_HEADER    Header;
} EFI_IFR_CATENATE;

typedef struct _EFI_IFR_DIVIDE {
  EFI_IFR_OP_HEADER    Header;
} EFI_IFR_DIVIDE;

typedef struct _EFI_IFR_EQUAL {
  EFI_IFR_OP_HEADER    Header;
} EFI_IFR_EQUAL;

typedef struct _EFI_IFR_GREATER_EQUAL {
  EFI_IFR_OP_HEADER    Header;
} EFI_IFR_GREATER_EQUAL;

typedef struct _EFI_IFR_GREATER_THAN {
  EFI_IFR_OP_HEADER    Header;
} EFI_IFR_GREATER_THAN;

typedef struct _EFI_IFR_LESS_EQUAL {
  EFI_IFR_OP_HEADER    Header;
} EFI_IFR_LESS_EQUAL;

typedef struct _EFI_IFR_LESS_THAN {
  EFI_IFR_OP_HEADER    Header;
} EFI_IFR_LESS_THAN;

typedef struct _EFI_IFR_MATCH {
  EFI_IFR_OP_HEADER    Header;
} EFI_IFR_MATCH;

typedef struct _EFI_IFR_MATCH2 {
  EFI_IFR_OP_HEADER    Header;
  EFI_GUID             SyntaxType;
} EFI_IFR_MATCH2;

typedef struct _EFI_IFR_MULTIPLY {
  EFI_IFR_OP_HEADER    Header;
} EFI_IFR_MULTIPLY;

typedef struct _EFI_IFR_MODULO {
  EFI_IFR_OP_HEADER    Header;
} EFI_IFR_MODULO;

typedef struct _EFI_IFR_NOT_EQUAL {
  EFI_IFR_OP_HEADER    Header;
} EFI_IFR_NOT_EQUAL;

typedef struct _EFI_IFR_OR {
  EFI_IFR_OP_HEADER    Header;
} EFI_IFR_OR;

typedef struct _EFI_IFR_SHIFT_LEFT {
  EFI_IFR_OP_HEADER    Header;
} EFI_IFR_SHIFT_LEFT;

typedef struct _EFI_IFR_SHIFT_RIGHT {
  EFI_IFR_OP_HEADER    Header;
} EFI_IFR_SHIFT_RIGHT;

typedef struct _EFI_IFR_SUBTRACT {
  EFI_IFR_OP_HEADER    Header;
} EFI_IFR_SUBTRACT;

typedef struct _EFI_IFR_CONDITIONAL {
  EFI_IFR_OP_HEADER    Header;
} EFI_IFR_CONDITIONAL;

//

#define EFI_IFR_FF_CASE_INSENSITIVE  0x01

typedef struct _EFI_IFR_FIND {
  EFI_IFR_OP_HEADER    Header;
  UINT8                Format;
} EFI_IFR_FIND;

typedef struct _EFI_IFR_MID {
  EFI_IFR_OP_HEADER    Header;
} EFI_IFR_MID;

typedef struct _EFI_IFR_TOKEN {
  EFI_IFR_OP_HEADER    Header;
} EFI_IFR_TOKEN;

//
// Flags specifying whether to find the first matching string
// or the first non-matching string.
//
#define EFI_IFR_FLAGS_FIRST_MATCHING      0x00
#define EFI_IFR_FLAGS_FIRST_NON_MATCHING  0x01

typedef struct _EFI_IFR_SPAN {
  EFI_IFR_OP_HEADER    Header;
  UINT8                Flags;
} EFI_IFR_SPAN;

typedef struct _EFI_IFR_SECURITY {
  ///
  /// Standard opcode header, where Header.Op = EFI_IFR_SECURITY_OP.
  ///
  EFI_IFR_OP_HEADER    Header;
  ///
  /// Security permission level.
  ///
  EFI_GUID             Permissions;
} EFI_IFR_SECURITY;

typedef struct _EFI_IFR_FORM_MAP_METHOD {

  /// The string identifier which provides the human-readable name of
  /// the configuration method for this standards map form.
  ///
  EFI_STRING_ID    MethodTitle;
  ///
  /// Identifier which uniquely specifies the configuration methods
  /// associated with this standards map form.
  ///
  EFI_GUID         MethodIdentifier;
} EFI_IFR_FORM_MAP_METHOD;

typedef struct _EFI_IFR_FORM_MAP {

  /// The sequence that defines the type of opcode as well as the length
  /// of the opcode being defined. Header.OpCode = EFI_IFR_FORM_MAP_OP.
  ///
  EFI_IFR_OP_HEADER    Header;
  ///
  /// The unique identifier for this particular form.
  ///
  EFI_FORM_ID          FormId;
  ///
  /// One or more configuration method's name and unique identifier.
  ///

  /// The sequence that defines the type of opcode as well as the length
  /// of the opcode being defined. Header.OpCode = EFI_IFR_SET_OP.
  ///
  EFI_IFR_OP_HEADER    Header;
  ///
  /// Specifies the identifier of a previously declared variable store to
  /// use when storing the question's value.
  ///
  EFI_VARSTORE_ID      VarStoreId;
  union {
    ///
    /// A 16-bit Buffer Storage offset.

  ///
  /// Specifies the type used for storage.
  ///
  UINT8    VarStoreType;
} EFI_IFR_SET;

typedef struct _EFI_IFR_GET {

  /// The sequence that defines the type of opcode as well as the length
  /// of the opcode being defined. Header.OpCode = EFI_IFR_GET_OP.
  ///
  EFI_IFR_OP_HEADER    Header;
  ///
  /// Specifies the identifier of a previously declared variable store to
  /// use when retrieving the value.
  ///
  EFI_VARSTORE_ID      VarStoreId;
  union {
    ///
    /// A 16-bit Buffer Storage offset.

  ///
  /// Specifies the type used for storage.
  ///
  UINT8    VarStoreType;
} EFI_IFR_GET;

typedef struct _EFI_IFR_READ {
  EFI_IFR_OP_HEADER    Header;
} EFI_IFR_READ;

typedef struct _EFI_IFR_WRITE {
  EFI_IFR_OP_HEADER    Header;
} EFI_IFR_WRITE;

typedef struct _EFI_IFR_MAP {
  EFI_IFR_OP_HEADER    Header;
} EFI_IFR_MAP;
//
// Definitions for Keyboard Package

  EfiKeyF12,
  EfiKeyPrint,
  EfiKeySLck,
  EfiKeyPause,
  EfiKeyIntl0,
  EfiKeyIntl1,
  EfiKeyIntl2,
  EfiKeyIntl3,
  EfiKeyIntl4,
  EfiKeyIntl5,
  EfiKeyIntl6,
  EfiKeyIntl7,
  EfiKeyIntl8,
  EfiKeyIntl9
} EFI_KEY;

typedef struct {
  ///
  /// Used to describe a physical key on a keyboard.
  ///
  EFI_KEY    Key;
  ///
  /// Unicode character code for the Key.
  ///
  CHAR16     Unicode;
  ///
  /// Unicode character code for the key with the shift key being held down.
  ///
  CHAR16     ShiftedUnicode;
  ///
  /// Unicode character code for the key with the Alt-GR being held down.
  ///
  CHAR16     AltGrUnicode;
  ///
  /// Unicode character code for the key with the Alt-GR and shift keys being held down.
  ///
  CHAR16     ShiftedAltGrUnicode;
  ///
  /// Modifier keys are defined to allow for special functionality that is not necessarily
  /// accomplished by a printable character. Many of these modifier keys are flags to toggle
  /// certain state bits on and off inside of a keyboard driver.
  ///
  UINT16     Modifier;
  UINT16     AffectedAttribute;
} EFI_KEY_DESCRIPTOR;

///
/// A key which is affected by all the standard shift modifiers.
/// Most keys would be expected to have this bit active.
///
#define EFI_AFFECTED_BY_STANDARD_SHIFT  0x0001

///
/// This key is affected by the caps lock so that if a keyboard driver

/// versus an "a" character.  Having this bit turned on would tell
/// the keyboard driver to use the appropriate shifted state or not.
///
#define EFI_AFFECTED_BY_CAPS_LOCK  0x0002

///
/// Similar to the case of CAPS lock, if this bit is active, the key
/// is affected by the num lock being turned on.
///
#define EFI_AFFECTED_BY_NUM_LOCK  0x0004

typedef struct {
  UINT16      LayoutLength;
  EFI_GUID    Guid;
  UINT32      LayoutDescriptorStringOffset;
  UINT8       DescriptorCount;
  // EFI_KEY_DESCRIPTOR    Descriptors[];
} EFI_HII_KEYBOARD_LAYOUT;

typedef struct {
  EFI_HII_PACKAGE_HEADER    Header;
  UINT16                    LayoutCount;
  // EFI_HII_KEYBOARD_LAYOUT Layout[];
} EFI_HII_KEYBOARD_PACKAGE_HDR;

//
// Modifier values
//
#define EFI_NULL_MODIFIER                 0x0000
#define EFI_LEFT_CONTROL_MODIFIER         0x0001
#define EFI_RIGHT_CONTROL_MODIFIER        0x0002
#define EFI_LEFT_ALT_MODIFIER             0x0003
#define EFI_RIGHT_ALT_MODIFIER            0x0004
#define EFI_ALT_GR_MODIFIER               0x0005
#define EFI_INSERT_MODIFIER               0x0006
#define EFI_DELETE_MODIFIER               0x0007
#define EFI_PAGE_DOWN_MODIFIER            0x0008
#define EFI_PAGE_UP_MODIFIER              0x0009
#define EFI_HOME_MODIFIER                 0x000A
#define EFI_END_MODIFIER                  0x000B
#define EFI_LEFT_SHIFT_MODIFIER           0x000C
#define EFI_RIGHT_SHIFT_MODIFIER          0x000D
#define EFI_CAPS_LOCK_MODIFIER            0x000E
#define EFI_NUM_LOCK_MODIFIER             0x000F
#define EFI_LEFT_ARROW_MODIFIER           0x0010
#define EFI_RIGHT_ARROW_MODIFIER          0x0011
#define EFI_DOWN_ARROW_MODIFIER           0x0012
#define EFI_UP_ARROW_MODIFIER             0x0013
#define EFI_NS_KEY_MODIFIER               0x0014
#define EFI_NS_KEY_DEPENDENCY_MODIFIER    0x0015
#define EFI_FUNCTION_KEY_ONE_MODIFIER     0x0016
#define EFI_FUNCTION_KEY_TWO_MODIFIER     0x0017
#define EFI_FUNCTION_KEY_THREE_MODIFIER   0x0018
#define EFI_FUNCTION_KEY_FOUR_MODIFIER    0x0019
#define EFI_FUNCTION_KEY_FIVE_MODIFIER    0x001A
#define EFI_FUNCTION_KEY_SIX_MODIFIER     0x001B
#define EFI_FUNCTION_KEY_SEVEN_MODIFIER   0x001C
#define EFI_FUNCTION_KEY_EIGHT_MODIFIER   0x001D
#define EFI_FUNCTION_KEY_NINE_MODIFIER    0x001E
#define EFI_FUNCTION_KEY_TEN_MODIFIER     0x001F
#define EFI_FUNCTION_KEY_ELEVEN_MODIFIER  0x0020
#define EFI_FUNCTION_KEY_TWELVE_MODIFIER  0x0021

//
// Keys that have multiple control functions based on modifier

// is still a nonprinting character, but might have an alternate
// control function like SYSREQUEST
//
#define EFI_PRINT_MODIFIER        0x0022
#define EFI_SYS_REQUEST_MODIFIER  0x0023
#define EFI_SCROLL_LOCK_MODIFIER  0x0024
#define EFI_PAUSE_MODIFIER        0x0025
#define EFI_BREAK_MODIFIER        0x0026

#define EFI_LEFT_LOGO_MODIFIER   0x0027
#define EFI_RIGHT_LOGO_MODIFIER  0x0028
#define EFI_MENU_MODIFIER        0x0029

///
/// Animation IFR opcode

  /// Standard opcode header, where Header.OpCode is
  /// EFI_IFR_ANIMATION_OP.
  ///
  EFI_IFR_OP_HEADER    Header;
  ///
  /// Animation identifier in the HII database.
  ///
  EFI_ANIMATION_ID     Id;
} EFI_IFR_ANIMATION;

///

  ///
  /// Standard package header, where Header.Type = EFI_HII_PACKAGE_ANIMATIONS.
  ///
  EFI_HII_PACKAGE_HEADER    Header;
  ///
  /// Offset, relative to this header, of the animation information. If
  /// this is zero, then there are no animation sequences in the package.
  ///
  UINT32                    AnimationInfoOffset;
} EFI_HII_ANIMATION_PACKAGE_HDR;

///

/// with each block prefixed by a single byte header EFI_HII_ANIMATION_BLOCK.
///
typedef struct _EFI_HII_ANIMATION_BLOCK {
  UINT8    BlockType;
  // UINT8  BlockBody[];
} EFI_HII_ANIMATION_BLOCK;

///
/// Animation block types.
///
#define EFI_HII_AIBT_END                  0x00
#define EFI_HII_AIBT_OVERLAY_IMAGES       0x10
#define EFI_HII_AIBT_CLEAR_IMAGES         0x11
#define EFI_HII_AIBT_RESTORE_SCRN         0x12
#define EFI_HII_AIBT_OVERLAY_IMAGES_LOOP  0x18
#define EFI_HII_AIBT_CLEAR_IMAGES_LOOP    0x19
#define EFI_HII_AIBT_RESTORE_SCRN_LOOP    0x1A
#define EFI_HII_AIBT_DUPLICATE            0x20
#define EFI_HII_AIBT_SKIP2                0x21
#define EFI_HII_AIBT_SKIP1                0x22
#define EFI_HII_AIBT_EXT1                 0x30
#define EFI_HII_AIBT_EXT2                 0x31
#define EFI_HII_AIBT_EXT4                 0x32

///
/// Extended block headers used for variable sized animation records

  ///
  /// Standard animation header, where Header.BlockType = EFI_HII_AIBT_EXT1.
  ///
  EFI_HII_ANIMATION_BLOCK    Header;
  ///
  /// The block type.
  ///
  UINT8                      BlockType2;
  ///
  /// Size of the animation block, in bytes, including the animation block header.
  ///
  UINT8                      Length;
} EFI_HII_AIBT_EXT1_BLOCK;

typedef struct _EFI_HII_AIBT_EXT2_BLOCK {
  ///
  /// Standard animation header, where Header.BlockType = EFI_HII_AIBT_EXT2.
  ///
  EFI_HII_ANIMATION_BLOCK    Header;
  ///
  /// The block type
  ///
  UINT8                      BlockType2;
  ///
  /// Size of the animation block, in bytes, including the animation block header.
  ///
  UINT16                     Length;
} EFI_HII_AIBT_EXT2_BLOCK;

typedef struct _EFI_HII_AIBT_EXT4_BLOCK {
  ///
  /// Standard animation header, where Header.BlockType = EFI_HII_AIBT_EXT4.
  ///
  EFI_HII_ANIMATION_BLOCK    Header;
  ///
  /// The block type
  ///
  UINT8                      BlockType2;
  ///
  /// Size of the animation block, in bytes, including the animation block header.
  ///
  UINT32                     Length;
} EFI_HII_AIBT_EXT4_BLOCK;

typedef struct _EFI_HII_ANIMATION_CELL {

  /// The X offset from the upper left hand corner of the logical
  /// window to position the indexed image.
  ///
  UINT16          OffsetX;
  ///
  /// The Y offset from the upper left hand corner of the logical
  /// window to position the indexed image.
  ///
  UINT16          OffsetY;
  ///
  /// The image to display at the specified offset from the upper left
  /// hand corner of the logical window.
  ///
  EFI_IMAGE_ID    ImageId;
  ///
  /// The number of milliseconds to delay after displaying the indexed
  /// image and before continuing on to the next linked image.  If value
  /// is zero, no delay.
  ///
  UINT16          Delay;
} EFI_HII_ANIMATION_CELL;

///

  /// image that can be displayed alone. If the value is zero, no image
  /// is displayed.
  ///
  EFI_IMAGE_ID              DftImageId;
  ///
  /// The overall width of the set of images (logical window width).
  ///
  UINT16                    Width;
  ///
  /// The overall height of the set of images (logical window height).
  ///
  UINT16                    Height;
  ///
  /// The number of EFI_HII_ANIMATION_CELL contained in the
  /// animation sequence.
  ///
  UINT16                    CellCount;
  ///
  /// An array of CellCount animation cells.
  ///
  EFI_HII_ANIMATION_CELL    AnimationCell[1];
} EFI_HII_AIBT_OVERLAY_IMAGES_BLOCK;

///

  /// image that can be displayed alone. If the value is zero, no image
  /// is displayed.
  ///
  EFI_IMAGE_ID              DftImageId;
  ///
  /// The overall width of the set of images (logical window width).
  ///
  UINT16                    Width;
  ///
  /// The overall height of the set of images (logical window height).
  ///
  UINT16                    Height;
  ///
  /// The number of EFI_HII_ANIMATION_CELL contained in the
  /// animation sequence.
  ///
  UINT16                    CellCount;
  ///
  /// The color to clear the logical window to before displaying the
  /// indexed image.
  ///
  EFI_HII_RGB_PIXEL         BackgndColor;
  ///
  /// An array of CellCount animation cells.
  ///
  EFI_HII_ANIMATION_CELL    AnimationCell[1];
} EFI_HII_AIBT_CLEAR_IMAGES_BLOCK;

///

  /// image that can be displayed alone. If the value is zero, no image
  /// is displayed.
  ///
  EFI_IMAGE_ID              DftImageId;
  ///
  /// The overall width of the set of images (logical window width).
  ///
  UINT16                    Width;
  ///
  /// The overall height of the set of images (logical window height).
  ///
  UINT16                    Height;
  ///
  /// The number of EFI_HII_ANIMATION_CELL contained in the
  /// animation sequence.
  ///
  UINT16                    CellCount;
  ///
  /// An array of CellCount animation cells.
  ///
  EFI_HII_ANIMATION_CELL    AnimationCell[1];
} EFI_HII_AIBT_RESTORE_SCRN_BLOCK;

///
/// An animation block to describe an animation sequence that continuously cycles,
/// and where one image is simply displayed over the previous image.
///
typedef EFI_HII_AIBT_OVERLAY_IMAGES_BLOCK EFI_HII_AIBT_OVERLAY_IMAGES_LOOP_BLOCK;

///
/// An animation block to describe an animation sequence that continuously cycles,
/// and where the logical window is cleared to the specified color before
/// the next image is displayed.
///
typedef EFI_HII_AIBT_CLEAR_IMAGES_BLOCK EFI_HII_AIBT_CLEAR_IMAGES_LOOP_BLOCK;

///
/// An animation block to describe an animation sequence that continuously cycles,
/// and where the screen is restored to the original state before
/// the next image is displayed.
///
typedef EFI_HII_AIBT_RESTORE_SCRN_BLOCK EFI_HII_AIBT_RESTORE_SCRN_LOOP_BLOCK;

///
/// Assigns a new character value to a previously defined animation sequence.

  /// The previously defined animation ID with the exact same
  /// animation information.
  ///
  EFI_ANIMATION_ID    AnimationId;
} EFI_HII_AIBT_DUPLICATE_BLOCK;

///

  ///
  /// The unsigned 8-bit value to add to AnimationIdCurrent.
  ///
  UINT8    SkipCount;
} EFI_HII_AIBT_SKIP1_BLOCK;

///

  ///
  /// The unsigned 16-bit value to add to AnimationIdCurrent.
  ///
  UINT16    SkipCount;
} EFI_HII_AIBT_SKIP2_BLOCK;

#pragma pack()



///
/// References to string tokens must use this macro to enable scanning for
/// token usages.

/// STRING_TOKEN is not defined in UEFI specification. But it is placed
/// here for the easy access by C files and VFR source files.
///
#define STRING_TOKEN(t)  t

///
/// IMAGE_TOKEN is not defined in UEFI specification. But it is placed
/// here for the easy access by C files and VFR source files.
///
#define IMAGE_TOKEN(t)  t

#endif




///
/// Attributes of variable.
///
#define EFI_VARIABLE_NON_VOLATILE        0x00000001
#define EFI_VARIABLE_BOOTSERVICE_ACCESS  0x00000002
#define EFI_VARIABLE_RUNTIME_ACCESS      0x00000004
///
/// This attribute is identified by the mnemonic 'HR'
/// elsewhere in this specification.
///
#define EFI_VARIABLE_HARDWARE_ERROR_RECORD  0x00000008
///
/// Attributes of Authenticated Variable
///
#define EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS  0x00000020
#define EFI_VARIABLE_APPEND_WRITE                           0x00000040
///
/// NOTE: EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS is deprecated and should be considered reserved.
///
#define EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS  0x00000010

#ifndef VFRCOMPILE
  #include <Guid/WinCertificate.h>
///
/// Enumeration of memory types introduced in UEFI.
///

  /// however it happens to also support byte-addressable non-volatility.
  ///
  EfiPersistentMemory,
  ///
  /// A memory region that describes system memory that has not been accepted
  /// by a corresponding call to the underlying isolation architecture.
  ///
  EfiUnacceptedMemoryType,
  EfiMaxMemoryType
} EFI_MEMORY_TYPE;


  /// Unique signatures have been generated for the EFI System Table,
  /// the EFI Boot Services Table, and the EFI Runtime Services Table.
  ///
  UINT64    Signature;
  ///
  /// The revision of the EFI Specification to which this table
  /// conforms. The upper 16 bits of this field contain the major
  /// revision value, and the lower 16 bits contain the minor revision
  /// value. The minor revision values are limited to the range of 00..99.
  ///
  UINT32    Revision;
  ///
  /// The size, in bytes, of the entire table including the EFI_TABLE_HEADER.
  ///
  UINT32    HeaderSize;
  ///
  /// The 32-bit CRC for the entire table. This value is computed by
  /// setting this field to 0, and computing the 32-bit CRC for HeaderSize bytes.
  ///
  UINT32    CRC32;
  ///
  /// Reserved field that must be set to 0.
  ///
  UINT32    Reserved;
} EFI_TABLE_HEADER;

///

  /// replay. Incremented during each
  /// "Write" access.
  ///
  UINT64    MonotonicCount;
  ///
  /// Provides the authorization for the variable
  /// access. It is a signature across the

  /// associated with a public key that has been
  /// provisioned via the key exchange.
  ///
  WIN_CERTIFICATE_UEFI_GUID    AuthInfo;
} EFI_VARIABLE_AUTHENTICATION;

///

  /// For the TimeStamp value, components Pad1, Nanosecond, TimeZone, Daylight and
  /// Pad2 shall be set to 0. This means that the time shall always be expressed in GMT.
  ///
  EFI_TIME                     TimeStamp;
  ///
  /// Only a CertType of  EFI_CERT_TYPE_PKCS7_GUID is accepted.
  ///
  WIN_CERTIFICATE_UEFI_GUID    AuthInfo;
} EFI_VARIABLE_AUTHENTICATION_2;
#endif // VFRCOMPILE

#endif




///
/// UNDI ROM ID and devive ID signature.
///
#define PXE_BUSTYPE_PXE  PXE_BUSTYPE ('!', 'P', 'X', 'E')

///
/// BUS ROM ID signatures.
///
#define PXE_BUSTYPE_PCI      PXE_BUSTYPE ('P', 'C', 'I', 'R')
#define PXE_BUSTYPE_PC_CARD  PXE_BUSTYPE ('P', 'C', 'C', 'R')
#define PXE_BUSTYPE_USB      PXE_BUSTYPE ('U', 'S', 'B', 'R')
#define PXE_BUSTYPE_1394     PXE_BUSTYPE ('1', '3', '9', '4')

#define PXE_SWAP_UINT16(n)  ((((PXE_UINT16) (n) & 0x00FF) << 8) | (((PXE_UINT16) (n) & 0xFF00) >> 8))


   (((PXE_UINT64)(n) & 0x00FF000000000000ULL) >> 40) | \
   (((PXE_UINT64)(n) & 0xFF00000000000000ULL) >> 56))


#define PXE_CPBSIZE_NOT_USED  0               ///< zero
#define PXE_DBSIZE_NOT_USED   0               ///< zero
#define PXE_CPBADDR_NOT_USED  (PXE_UINT64) 0  ///< zero
#define PXE_DBADDR_NOT_USED   (PXE_UINT64) 0  ///< zero
#define PXE_CONST             CONST

#define PXE_VOLATILE  volatile

typedef VOID    PXE_VOID;
typedef UINT8   PXE_UINT8;
typedef UINT16  PXE_UINT16;
typedef UINT32  PXE_UINT32;
typedef UINTN   PXE_UINTN;

///
/// Typedef unsigned long PXE_UINT64.
///
typedef UINT64 PXE_UINT64;

typedef PXE_UINT8 PXE_BOOL;
#define PXE_FALSE  0           ///< zero
#define PXE_TRUE   (!PXE_FALSE)

typedef PXE_UINT16 PXE_OPCODE;

///
/// Return UNDI operational state.

///
/// Change UNDI operational state from Started to Stopped.
///
#define PXE_OPCODE_STOP  0x0002

///
/// Get UNDI initialization information.

///
/// Changed UNDI operational state from Started to Initialized.
///
#define PXE_OPCODE_INITIALIZE  0x0005

///
/// Re-initialize the NIC H/W.

///
/// Change the UNDI operational state from Initialized to Started.
///
#define PXE_OPCODE_SHUTDOWN  0x0007

///
/// Read & change state of external interrupt enables.

///
/// Read traffic statistics.
///
#define PXE_OPCODE_STATISTICS  0x000B

///
/// Convert multicast IP address to multicast MAC address.

///
/// Read or change non-volatile storage on the NIC.
///
#define PXE_OPCODE_NVDATA  0x000D

///
/// Get & clear interrupt status.
///
#define PXE_OPCODE_GET_STATUS  0x000E

///
/// Fill media header in packet for transmit.

///
/// Transmit packet(s).
///
#define PXE_OPCODE_TRANSMIT  0x0010

///
/// Receive packet.

///
/// Last valid PXE UNDI OpCode number.
///
#define PXE_OPCODE_LAST_VALID  0x0011

typedef PXE_UINT16 PXE_OPFLAGS;

#define PXE_OPFLAGS_NOT_USED  0x0000


/// Select whether to enable or disable external interrupt signals.
/// Setting both enable and disable will return PXE_STATCODE_INVALID_OPFLAGS.
///
#define PXE_OPFLAGS_INTERRUPT_OPMASK   0xC000
#define PXE_OPFLAGS_INTERRUPT_ENABLE   0x8000
#define PXE_OPFLAGS_INTERRUPT_DISABLE  0x4000
#define PXE_OPFLAGS_INTERRUPT_READ     0x0000

///
/// Enable receive interrupts.  An external interrupt will be generated
/// after a complete non-error packet has been received.
///
#define PXE_OPFLAGS_INTERRUPT_RECEIVE  0x0001

///
/// Enable transmit interrupts.  An external interrupt will be generated

/// Enable command interrupts.  An external interrupt will be generated
/// when command execution stops.
///
#define PXE_OPFLAGS_INTERRUPT_COMMAND  0x0004

///
/// Generate software interrupt.  Setting this bit generates an external

/// To reset the contents of the multicast MAC address filter list,
/// set this OpFlag:
///
#define PXE_OPFLAGS_RECEIVE_FILTER_RESET_MCAST_LIST  0x2000

///
/// Enable unicast packet receiving.  Packets sent to the current station

/// of the multicast MAC addresses in the multicast MAC address filter
/// list will be received.  If the filter list is empty, no multicast
///
#define PXE_OPFLAGS_RECEIVE_FILTER_FILTERED_MULTICAST  0x0004

///
/// Enable promiscuous packet receiving.  All packets will be received.

///
/// Select the type of non-volatile data operation.
///
#define PXE_OPFLAGS_NVDATA_OPMASK  0x0001
#define PXE_OPFLAGS_NVDATA_READ    0x0000
#define PXE_OPFLAGS_NVDATA_WRITE   0x0001

///
/// UNDI Get Status.

/// buffers.  Do not plan on getting one buffer per interrupt.  Some
/// NICs and UNDIs may transmit multiple buffers per interrupt.
///
#define PXE_OPFLAGS_GET_TRANSMITTED_BUFFERS  0x0002

///
/// Return current media status.
///
#define PXE_OPFLAGS_GET_MEDIA_STATUS  0x0004

///
/// UNDI Fill Header.

#define PXE_OPFLAGS_TRANSMIT_BLOCK          0x0001
#define PXE_OPFLAGS_TRANSMIT_DONT_BLOCK     0x0000

#define PXE_OPFLAGS_TRANSMIT_OPMASK      0x0002
#define PXE_OPFLAGS_TRANSMIT_FRAGMENTED  0x0002
#define PXE_OPFLAGS_TRANSMIT_WHOLE       0x0000

///
/// UNDI Receive.

///
/// PXE STATFLAGS.
///
typedef PXE_UINT16 PXE_STATFLAGS;

#define PXE_STATFLAGS_INITIALIZE  0x0000


///
/// UNDI Get State.
///
#define PXE_STATFLAGS_GET_STATE_MASK         0x0003
#define PXE_STATFLAGS_GET_STATE_INITIALIZED  0x0002
#define PXE_STATFLAGS_GET_STATE_STARTED      0x0001
#define PXE_STATFLAGS_GET_STATE_STOPPED      0x0000

///
/// UNDI Start.

///
/// If set, receive interrupts are enabled.
///
#define PXE_STATFLAGS_INTERRUPT_RECEIVE  0x0001

///
/// If set, transmit interrupts are enabled.

///
/// If set, command interrupts are enabled.
///
#define PXE_STATFLAGS_INTERRUPT_COMMAND  0x0004

///
/// UNDI Receive Filters.

/// If set, multicast packets that match up with the multicast address
/// filter list will be received.
///
#define PXE_STATFLAGS_RECEIVE_FILTER_FILTERED_MULTICAST  0x0004

///
/// If set, all packets will be received.

///
/// Use to determine if an interrupt has occurred.
///
#define PXE_STATFLAGS_GET_STATUS_INTERRUPT_MASK  0x000F
#define PXE_STATFLAGS_GET_STATUS_NO_INTERRUPTS   0x0000

///
/// If set, at least one receive interrupt occurred.

///
/// If set, at least one transmit interrupt occurred.
///
#define PXE_STATFLAGS_GET_STATUS_TRANSMIT  0x0002

///
/// If set, at least one command interrupt occurred.

///
/// If set, at least one software interrupt occurred.
///
#define PXE_STATFLAGS_GET_STATUS_SOFTWARE  0x0008

///
/// This flag is set if the transmitted buffer queue is empty.  This flag


///
/// UNDI Receive
/// .

///
/// No additional StatFlags.
///
typedef PXE_UINT16 PXE_STATCODE;

#define PXE_STATCODE_INITIALIZE  0x0000

///
/// Common StatCodes returned by all UNDI commands, UNDI protocol functions
/// and BC protocol functions.
///
#define PXE_STATCODE_SUCCESS  0x0000

#define PXE_STATCODE_INVALID_CDB          0x0001
#define PXE_STATCODE_INVALID_CPB          0x0002

#define PXE_STATCODE_NOT_ENOUGH_MEMORY    0x0012
#define PXE_STATCODE_NO_DATA              0x0013

typedef PXE_UINT16 PXE_IFNUM;

///
/// This interface number must be passed to the S/W UNDI Start command.
///
#define PXE_IFNUM_START  0x0000

///
/// This interface number is returned by the S/W UNDI Get State and
/// Start commands if information in the CDB, CPB or DB is invalid.
///
#define PXE_IFNUM_INVALID  0x0000

typedef PXE_UINT16 PXE_CONTROL;

///
/// Setting this flag directs the UNDI to queue this command for later

/// is returned.  If the queue is full, a PXE_STATCODE_CDB_QUEUE_FULL
/// error is returned.
///
#define PXE_CONTROL_QUEUE_IF_BUSY  0x0002

///
/// These two bit values are used to determine if there are more UNDI

#define PXE_CONTROL_LINK              0x0001
#define PXE_CONTROL_LAST_CDB_IN_LIST  0x0000

typedef PXE_UINT8 PXE_FRAME_TYPE;

#define PXE_FRAME_TYPE_NONE                   0x00
#define PXE_FRAME_TYPE_UNICAST                0x01
#define PXE_FRAME_TYPE_BROADCAST              0x02
#define PXE_FRAME_TYPE_FILTERED_MULTICAST     0x03
#define PXE_FRAME_TYPE_PROMISCUOUS            0x04
#define PXE_FRAME_TYPE_PROMISCUOUS_MULTICAST  0x05

#define PXE_FRAME_TYPE_MULTICAST  PXE_FRAME_TYPE_FILTERED_MULTICAST

typedef PXE_UINT32 PXE_IPV4;

typedef PXE_UINT32 PXE_IPV6[4];
#define PXE_MAC_LENGTH  32

typedef PXE_UINT8 PXE_MAC_ADDR[PXE_MAC_LENGTH];

typedef PXE_UINT8 PXE_IFTYPE;
typedef UINT16    PXE_MEDIA_PROTOCOL;

///
/// This information is from the ARP section of RFC 1700.

#define PXE_IFTYPE_FIBRE_CHANNEL  0x12

typedef struct s_pxe_hw_undi {
  PXE_UINT32    Signature;      ///< PXE_ROMID_SIGNATURE.
  PXE_UINT8     Len;            ///< sizeof(PXE_HW_UNDI).
  PXE_UINT8     Fudge;          ///< makes 8-bit cksum equal zero.
  PXE_UINT8     Rev;            ///< PXE_ROMID_REV.
  PXE_UINT8     IFcnt;          ///< physical connector count lower byte.
  PXE_UINT8     MajorVer;       ///< PXE_ROMID_MAJORVER.
  PXE_UINT8     MinorVer;       ///< PXE_ROMID_MINORVER.
  PXE_UINT8     IFcntExt;       ///< physical connector count upper byte.
  PXE_UINT8     reserved;       ///< zero, not used.
  PXE_UINT32    Implementation; ///< implementation flags.
  ///< reserved             ///< vendor use.
  ///< UINT32 Status;       ///< status port.
  ///< UINT32 Command;      ///< command port.

///
/// If set, last command failed.
///
#define PXE_HWSTAT_COMMAND_FAILED  0x20000000

///
/// If set, identifies enabled receive filters.
///
#define PXE_HWSTAT_PROMISCUOUS_MULTICAST_RX_ENABLED  0x00001000
#define PXE_HWSTAT_PROMISCUOUS_RX_ENABLED            0x00000800
#define PXE_HWSTAT_BROADCAST_RX_ENABLED              0x00000400
#define PXE_HWSTAT_MULTICAST_RX_ENABLED              0x00000200
#define PXE_HWSTAT_UNICAST_RX_ENABLED                0x00000100

///
/// If set, identifies enabled external interrupts.
///
#define PXE_HWSTAT_SOFTWARE_INT_ENABLED      0x00000080
#define PXE_HWSTAT_TX_COMPLETE_INT_ENABLED   0x00000040
#define PXE_HWSTAT_PACKET_RX_INT_ENABLED     0x00000020
#define PXE_HWSTAT_CMD_COMPLETE_INT_ENABLED  0x00000010

///
/// If set, identifies pending interrupts.
///
#define PXE_HWSTAT_SOFTWARE_INT_PENDING      0x00000008
#define PXE_HWSTAT_TX_COMPLETE_INT_PENDING   0x00000004
#define PXE_HWSTAT_PACKET_RX_INT_PENDING     0x00000002
#define PXE_HWSTAT_CMD_COMPLETE_INT_PENDING  0x00000001

///
/// Command port definitions.

///
/// Use these to enable/disable receive filters.
///
#define PXE_HWCMD_PROMISCUOUS_MULTICAST_RX_ENABLE  0x00001000
#define PXE_HWCMD_PROMISCUOUS_RX_ENABLE            0x00000800
#define PXE_HWCMD_BROADCAST_RX_ENABLE              0x00000400
#define PXE_HWCMD_MULTICAST_RX_ENABLE              0x00000200
#define PXE_HWCMD_UNICAST_RX_ENABLE                0x00000100

///
/// Use these to enable/disable external interrupts.
///
#define PXE_HWCMD_SOFTWARE_INT_ENABLE      0x00000080
#define PXE_HWCMD_TX_COMPLETE_INT_ENABLE   0x00000040
#define PXE_HWCMD_PACKET_RX_INT_ENABLE     0x00000020
#define PXE_HWCMD_CMD_COMPLETE_INT_ENABLE  0x00000010

///
/// Use these to clear pending external interrupts.

#define PXE_HWCMD_CLEAR_CMD_COMPLETE_INT  0x00000001

typedef struct s_pxe_sw_undi {
  PXE_UINT32    Signature;      ///< PXE_ROMID_SIGNATURE.
  PXE_UINT8     Len;            ///< sizeof(PXE_SW_UNDI).
  PXE_UINT8     Fudge;          ///< makes 8-bit cksum zero.
  PXE_UINT8     Rev;            ///< PXE_ROMID_REV.
  PXE_UINT8     IFcnt;          ///< physical connector count lower byte.
  PXE_UINT8     MajorVer;       ///< PXE_ROMID_MAJORVER.
  PXE_UINT8     MinorVer;       ///< PXE_ROMID_MINORVER.
  PXE_UINT8     IFcntExt;       ///< physical connector count upper byte.
  PXE_UINT8     reserved1;      ///< zero, not used.
  PXE_UINT32    Implementation; ///< Implementation flags.
  PXE_UINT64    EntryPoint;     ///< API entry point.
  PXE_UINT8     reserved2[3];   ///< zero, not used.
  PXE_UINT8     BusCnt;         ///< number of bustypes supported.
  PXE_UINT32    BusType[1];     ///< list of supported bustypes.
} PXE_SW_UNDI;

typedef union u_pxe_undi {
  PXE_HW_UNDI    hw;
  PXE_SW_UNDI    sw;
} PXE_UNDI;

///
/// Signature of !PXE structure.
///
#define PXE_ROMID_SIGNATURE  PXE_BUSTYPE ('!', 'P', 'X', 'E')

///
/// !PXE structure format revision
/// .
#define PXE_ROMID_REV  0x02

///
/// UNDI command interface revision.  These are the values that get sent
/// in option 94 (Client Network Interface Identifier) in the DHCP Discover
/// and PXE Boot Server Request packets.
///
#define PXE_ROMID_MAJORVER  0x03
#define PXE_ROMID_MINORVER  0x01

///
/// Implementation flags.

#define PXE_ROMID_IMP_CMD_COMPLETE_INT_SUPPORTED          0x00000001

typedef struct s_pxe_cdb {
  PXE_OPCODE       OpCode;
  PXE_OPFLAGS      OpFlags;
  PXE_UINT16       CPBsize;
  PXE_UINT16       DBsize;
  PXE_UINT64       CPBaddr;
  PXE_UINT64       DBaddr;
  PXE_STATCODE     StatCode;
  PXE_STATFLAGS    StatFlags;
  PXE_UINT16       IFnum;
  PXE_CONTROL      Control;
} PXE_CDB;

typedef union u_pxe_ip_addr {
  PXE_IPV6    IPv6;
  PXE_IPV4    IPv4;
} PXE_IP_ADDR;

typedef union pxe_device {

    /// See S/W UNDI ROMID structure definition for PCI and
    /// PCC BusType definitions.
    ///
    PXE_UINT32    BusType;

    ///
    /// Bus, device & function numbers that locate this device.
    ///
    PXE_UINT16    Bus;
    PXE_UINT8     Device;
    PXE_UINT8     Function;
  } PCI, PCC;
  PCI, PCC;

} PXE_DEVICE;

///
/// cpb and db definitions
///
#define MAX_PCI_CONFIG_LEN     64  ///< # of dwords.
#define MAX_EEPROM_LEN         128 ///< # of dwords.
#define MAX_XMIT_BUFFERS       32  ///< recycling Q length for xmit_done.
#define MAX_MCAST_ADDRESS_CNT  8

typedef struct s_pxe_cpb_start_30 {
  ///

  ///
  /// This field cannot be set to zero.
  ///
  UINT64    Delay;

  ///
  /// PXE_VOID Block(UINT32 enable);

  ///
  /// This field cannot be set to zero.
  ///
  UINT64    Block;

  ///
  /// PXE_VOID Virt2Phys(UINT64 virtual, UINT64 physical_ptr);

  /// This field can be set to zero if virtual and physical addresses
  /// are equal.
  ///
  UINT64    Virt2Phys;
  ///
  /// PXE_VOID Mem_IO(UINT8 read_write, UINT8 len, UINT64 port,
  ///              UINT64 buf_addr);

  ///
  /// This field can not be set to zero.
  ///
  UINT64    Mem_IO;
} PXE_CPB_START_30;

typedef struct s_pxe_cpb_start_31 {

  ///
  /// This field cannot be set to zero.
  ///
  UINT64    Delay;

  ///
  /// PXE_VOID Block(UINT64 unq_id, UINT32 enable);

  ///
  /// This field cannot be set to zero.
  ///
  UINT64    Block;

  ///
  /// PXE_VOID Virt2Phys(UINT64 UnqId, UINT64 virtual, UINT64 physical_ptr);

  /// This field can be set to zero if virtual and physical addresses
  /// are equal.
  ///
  UINT64    Virt2Phys;
  ///
  /// PXE_VOID Mem_IO(UINT64 UnqId, UINT8 read_write, UINT8 len, UINT64 port,
  ///              UINT64 buf_addr);

  ///
  /// This field can not be set to zero.
  ///
  UINT64    Mem_IO;
  ///
  /// PXE_VOID Map_Mem(UINT64 unq_id, UINT64 virtual_addr, UINT32 size,
  ///                 UINT32 Direction, UINT64 mapped_addr);

  ///
  /// This field can be set to zero if there is no mapping service available.
  ///
  UINT64    Map_Mem;

  ///
  /// PXE_VOID UnMap_Mem(UINT64 unq_id, UINT64 virtual_addr, UINT32 size,

  ///
  /// This field can be set to zero if there is no unmapping service available.
  ///
  UINT64    UnMap_Mem;

  ///
  /// PXE_VOID Sync_Mem(UINT64 unq_id, UINT64 virtual,

  ///
  /// This field can be set to zero if there is no service available.
  ///
  UINT64    Sync_Mem;

  ///
  /// protocol driver can provide anything for this Unique_ID, UNDI remembers

  /// the ifnum and gives it back as a parameter to all the call-back routines
  /// when calling for that interface!
  ///
  UINT64    Unique_ID;
} PXE_CPB_START_31;

#define TO_AND_FROM_DEVICE  0
#define FROM_DEVICE         1
#define TO_DEVICE           2

#define PXE_DELAY_MILLISECOND  1000
#define PXE_DELAY_SECOND       1000000
#define PXE_IO_READ            0
#define PXE_IO_WRITE           1
#define PXE_MEM_READ           2
#define PXE_MEM_WRITE          4

typedef struct s_pxe_db_get_init_info {
  ///

  /// If MemoryRequired is zero, the UNDI does not need and will not
  /// use system memory to receive and transmit packets.
  ///
  PXE_UINT32    MemoryRequired;

  ///
  /// Maximum frame data length for Tx/Rx excluding the media header.
  ///
  PXE_UINT32    FrameDataLen;

  ///
  /// Supported link speeds are in units of mega bits.  Common ethernet
  /// values are 10, 100 and 1000.  Unused LinkSpeeds[] entries are zero
  /// filled.
  ///
  PXE_UINT32    LinkSpeeds[4];

  ///
  /// Number of non-volatile storage items.
  ///
  PXE_UINT32    NvCount;

  ///
  /// Width of non-volatile storage item in bytes.  0, 1, 2 or 4
  ///
  PXE_UINT16    NvWidth;

  ///
  /// Media header length.  This is the typical media header length for
  /// this UNDI.  This information is needed when allocating receive
  /// and transmit buffers.
  ///
  PXE_UINT16    MediaHeaderLen;

  ///
  /// Number of bytes in the NIC hardware (MAC) address.
  ///
  PXE_UINT16    HWaddrLen;

  ///
  /// Maximum number of multicast MAC addresses in the multicast
  /// MAC address filter list.
  ///
  PXE_UINT16    MCastFilterCnt;

  ///
  /// Default number and size of transmit and receive buffers that will

  /// command.  If MemoryRequired is zero, this allocation will come out of
  /// memory on the NIC.
  ///
  PXE_UINT16    TxBufCnt;
  PXE_UINT16    TxBufSize;
  PXE_UINT16    RxBufCnt;
  PXE_UINT16    RxBufSize;

  ///
  /// Hardware interface types defined in the Assigned Numbers RFC
  /// and used in DHCP and ARP packets.
  /// See the PXE_IFTYPE typedef and PXE_IFTYPE_xxx macros.
  ///
  PXE_UINT8     IFtype;

  ///
  /// Supported duplex.  See PXE_DUPLEX_xxxxx #defines below.
  ///
  PXE_UINT8     SupportedDuplexModes;

  ///
  /// Supported loopback options.  See PXE_LOOPBACK_xxxxx #defines below.
  ///
  PXE_UINT8     SupportedLoopBackModes;
} PXE_DB_GET_INIT_INFO;

#define PXE_MAX_TXRX_UNIT_ETHER  1500

#define PXE_HWADDR_LEN_ETHER      0x0006
#define PXE_MAC_HEADER_LEN_ETHER  0x000E

#define PXE_DUPLEX_ENABLE_FULL_SUPPORTED  1
#define PXE_DUPLEX_FORCE_FULL_SUPPORTED   2

#define PXE_LOOPBACK_INTERNAL_SUPPORTED  1
#define PXE_LOOPBACK_EXTERNAL_SUPPORTED  2

typedef struct s_pxe_pci_config_info {
  ///
  /// This is the flag field for the PXE_DB_GET_CONFIG_INFO union.
  /// For PCI bus devices, this field is set to PXE_BUSTYPE_PCI.
  ///
  UINT32    BusType;

  ///
  /// This identifies the PCI network device that this UNDI interface.
  /// is bound to.
  ///
  UINT16    Bus;
  UINT8     Device;
  UINT8     Function;

  ///
  /// This is a copy of the PCI configuration space for this
  /// network device.
  ///
  union {
    UINT8     Byte[256];
    UINT16    Word[128];
    UINT32    Dword[64];
  } Config;
} PXE_PCI_CONFIG_INFO;


  /// This is the flag field for the PXE_DB_GET_CONFIG_INFO union.
  /// For PCC bus devices, this field is set to PXE_BUSTYPE_PCC.
  ///
  PXE_UINT32    BusType;

  ///
  /// This identifies the PCC network device that this UNDI interface
  /// is bound to.
  ///
  PXE_UINT16    Bus;
  PXE_UINT8     Device;
  PXE_UINT8     Function;

  ///
  /// This is a copy of the PCC configuration space for this
  /// network device.
  ///
  union {
    PXE_UINT8     Byte[256];
    PXE_UINT16    Word[128];
    PXE_UINT32    Dword[64];
  } Config;
} PXE_PCC_CONFIG_INFO;

typedef union u_pxe_db_get_config_info {
  PXE_PCI_CONFIG_INFO    pci;
  PXE_PCC_CONFIG_INFO    pcc;
} PXE_DB_GET_CONFIG_INFO;

typedef struct s_pxe_cpb_initialize {

  /// be in contiguous physical memory and cannot be swapped out.  The UNDI
  /// will be using this for transmit and receive buffering.
  ///
  PXE_UINT64    MemoryAddr;

  ///
  /// MemoryLength must be greater than or equal to MemoryRequired
  /// returned by the Get Init Info command.
  ///
  PXE_UINT32    MemoryLength;

  ///
  /// Desired link speed in Mbit/sec.  Common ethernet values are 10, 100
  /// and 1000.  Setting a value of zero will auto-detect and/or use the
  /// default link speed (operation depends on UNDI/NIC functionality).
  ///
  PXE_UINT32    LinkSpeed;

  ///
  /// Suggested number and size of receive and transmit buffers to

  /// If these fields are set to zero, the UNDI will allocate buffer
  /// counts and sizes as it sees fit.
  ///
  PXE_UINT16    TxBufCnt;
  PXE_UINT16    TxBufSize;
  PXE_UINT16    RxBufCnt;
  PXE_UINT16    RxBufSize;

  ///
  /// The following configuration parameters are optional and must be zero
  /// to use the default values.
  ///
  PXE_UINT8     DuplexMode;

  PXE_UINT8     LoopBackMode;
} PXE_CPB_INITIALIZE;

#define PXE_DUPLEX_DEFAULT       0x00
#define PXE_FORCE_FULL_DUPLEX    0x01
#define PXE_ENABLE_FULL_DUPLEX   0x02
#define PXE_FORCE_HALF_DUPLEX    0x04
#define PXE_DISABLE_FULL_DUPLEX  0x08

#define LOOPBACK_NORMAL    0
#define LOOPBACK_INTERNAL  1
#define LOOPBACK_EXTERNAL  2

typedef struct s_pxe_db_initialize {
  ///

  /// Memory used by the UNDI and network device is allocated from the
  /// lowest memory buffer address.
  ///
  PXE_UINT32    MemoryUsed;

  ///
  /// Actual number and size of receive and transmit buffers that were
  /// allocated.
  ///
  PXE_UINT16    TxBufCnt;
  PXE_UINT16    TxBufSize;
  PXE_UINT16    RxBufCnt;
  PXE_UINT16    RxBufSize;
} PXE_DB_INITIALIZE;

typedef struct s_pxe_cpb_receive_filters {

  /// List of multicast MAC addresses.  This list, if present, will
  /// replace the existing multicast MAC address filter list.
  ///
  PXE_MAC_ADDR    MCastList[MAX_MCAST_ADDRESS_CNT];
} PXE_CPB_RECEIVE_FILTERS;

typedef struct s_pxe_db_receive_filters {
  ///
  /// Filtered multicast MAC address list.
  ///
  PXE_MAC_ADDR    MCastList[MAX_MCAST_ADDRESS_CNT];
} PXE_DB_RECEIVE_FILTERS;

typedef struct s_pxe_cpb_station_address {

  /// If supplied and supported, the current station MAC address
  /// will be changed.
  ///
  PXE_MAC_ADDR    StationAddr;
} PXE_CPB_STATION_ADDRESS;

typedef struct s_pxe_dpb_station_address {
  ///
  /// Current station MAC address.
  ///
  PXE_MAC_ADDR    StationAddr;

  ///
  /// Station broadcast MAC address.
  ///
  PXE_MAC_ADDR    BroadcastAddr;

  ///
  /// Permanent station MAC address.
  ///
  PXE_MAC_ADDR    PermanentAddr;
} PXE_DB_STATION_ADDRESS;

typedef struct s_pxe_db_statistics {

  /// If bit 0x21 is set, Data[0x21] is collected.
  /// Etc.
  ///
  PXE_UINT64    Supported;

  ///
  /// Statistic data.
  ///
  PXE_UINT64    Data[64];
} PXE_DB_STATISTICS;

///

///
/// Number of valid frames received and copied into receive buffers.
///
#define PXE_STATISTICS_RX_GOOD_FRAMES  0x01

///
/// Number of frames below the minimum length for the media.

/// Number of frames longer than the maxminum length for the
/// media.  This would be >1500 for ethernet.
///
#define PXE_STATISTICS_RX_OVERSIZE_FRAMES  0x03

///
/// Valid frames that were dropped because receive buffers were full.

/// Total number of bytes received.  Includes frames with errors
/// and dropped frames.
///
#define PXE_STATISTICS_RX_TOTAL_BYTES  0x09

///
/// Transmit statistics.

///
/// Number of collisions detection on this subnet.
///
#define PXE_STATISTICS_COLLISIONS  0x14

///
/// Number of frames destined for unsupported protocol.
///
#define PXE_STATISTICS_UNSUPPORTED_PROTOCOL  0x15

///
/// Number of valid frames received that were duplicated.
///
#define PXE_STATISTICS_RX_DUPLICATED_FRAMES  0x16

///
/// Number of encrypted frames received that failed to decrypt.
///
#define PXE_STATISTICS_RX_DECRYPT_ERROR_FRAMES  0x17

///
/// Number of frames that failed to transmit after exceeding the retry limit.
///
#define PXE_STATISTICS_TX_ERROR_FRAMES  0x18

///
/// Number of frames transmitted successfully after more than one attempt.
///
#define PXE_STATISTICS_TX_RETRY_FRAMES  0x19

typedef struct s_pxe_cpb_mcast_ip_to_mac {
  ///
  /// Multicast IP address to be converted to multicast MAC address.
  ///
  PXE_IP_ADDR    IP;
} PXE_CPB_MCAST_IP_TO_MAC;

typedef struct s_pxe_db_mcast_ip_to_mac {
  ///
  /// Multicast MAC address.
  ///
  PXE_MAC_ADDR    MAC;
} PXE_DB_MCAST_IP_TO_MAC;

typedef struct s_pxe_cpb_nvdata_sparse {

    ///
    ///  Non-volatile storage address to be changed.
    ///
    PXE_UINT32    Addr;

    ///
    /// Data item to write into above storage address.
    ///
    union {
      PXE_UINT8     Byte;
      PXE_UINT16    Word;
      PXE_UINT32    Dword;
    } Data;
  } Item[MAX_EEPROM_LEN];
} PXE_CPB_NVDATA_SPARSE;

  ///
  /// Array of byte-wide data items.
  ///
  PXE_UINT8     Byte[MAX_EEPROM_LEN << 2];

  ///
  /// Array of word-wide data items.
  ///
  PXE_UINT16    Word[MAX_EEPROM_LEN << 1];

  ///
  /// Array of dword-wide data items.
  ///
  PXE_UINT32    Dword[MAX_EEPROM_LEN];
} PXE_CPB_NVDATA_BULK;

typedef struct s_pxe_db_nvdata {

    ///
    /// Array of byte-wide data items.
    ///
    PXE_UINT8     Byte[MAX_EEPROM_LEN << 2];

    ///
    /// Array of word-wide data items.
    ///
    PXE_UINT16    Word[MAX_EEPROM_LEN << 1];

    ///
    /// Array of dword-wide data items.
    ///
    PXE_UINT32    Dword[MAX_EEPROM_LEN];
  } Data;
} PXE_DB_NVDATA;


  /// Length of next receive frame (header + data).  If this is zero,
  /// there is no next receive frame available.
  ///
  PXE_UINT32    RxFrameLen;

  ///
  /// Reserved, set to zero.
  ///
  PXE_UINT32    reserved;

  ///
  ///  Addresses of transmitted buffers that need to be recycled.
  ///
  PXE_UINT64    TxBuffer[MAX_XMIT_BUFFERS];
} PXE_DB_GET_STATUS;

typedef struct s_pxe_cpb_fill_header {

  /// Source and destination MAC addresses.  These will be copied into
  /// the media header without doing byte swapping.
  ///
  PXE_MAC_ADDR    SrcAddr;
  PXE_MAC_ADDR    DestAddr;

  ///
  /// Address of first byte of media header.  The first byte of packet data
  /// follows the last byte of the media header.
  ///
  PXE_UINT64      MediaHeader;

  ///
  /// Length of packet data in bytes (not including the media header).
  ///
  PXE_UINT32      PacketLen;

  ///
  /// Protocol type.  This will be copied into the media header without
  /// doing byte swapping.  Protocol type numbers can be obtained from
  /// the Assigned Numbers RFC 1700.
  ///
  PXE_UINT16      Protocol;

  ///
  /// Length of the media header in bytes.
  ///
  PXE_UINT16      MediaHeaderLen;
} PXE_CPB_FILL_HEADER;

#define PXE_PROTOCOL_ETHERNET_IP   0x0800
#define PXE_PROTOCOL_ETHERNET_ARP  0x0806
#define MAX_XMIT_FRAGMENTS         16

typedef struct s_pxe_cpb_fill_header_fragmented {
  ///
  /// Source and destination MAC addresses.  These will be copied into
  /// the media header without doing byte swapping.
  ///
  PXE_MAC_ADDR          SrcAddr;
  PXE_MAC_ADDR          DestAddr;

  ///
  /// Length of packet data in bytes (not including the media header).
  ///
  PXE_UINT32            PacketLen;

  ///
  /// Protocol type.  This will be copied into the media header without
  /// doing byte swapping.  Protocol type numbers can be obtained from
  /// the Assigned Numbers RFC 1700.
  ///
  PXE_MEDIA_PROTOCOL    Protocol;

  ///
  /// Length of the media header in bytes.
  ///
  PXE_UINT16            MediaHeaderLen;

  ///
  /// Number of packet fragment descriptors.
  ///
  PXE_UINT16            FragCnt;

  ///
  /// Reserved, must be set to zero.
  ///
  PXE_UINT16            reserved;

  ///
  /// Array of packet fragment descriptors.  The first byte of the media

    ///
    /// Address of this packet fragment.
    ///
    PXE_UINT64    FragAddr;

    ///
    /// Length of this packet fragment.
    ///
    PXE_UINT32    FragLen;

    ///
    /// Reserved, must be set to zero.
    ///
    PXE_UINT32    reserved;
  } FragDesc[MAX_XMIT_FRAGMENTS];
} PXE_CPB_FILL_HEADER_FRAGMENTED;
PXE_CPB_FILL_HEADER_FRAGMENTED;

typedef struct s_pxe_cpb_transmit {
  ///
  /// Address of first byte of frame buffer.  This is also the first byte
  /// of the media header.
  ///
  PXE_UINT64    FrameAddr;

  ///
  /// Length of the data portion of the frame buffer in bytes.  Do not
  /// include the length of the media header.
  ///
  PXE_UINT32    DataLen;

  ///
  /// Length of the media header in bytes.
  ///
  PXE_UINT16    MediaheaderLen;

  ///
  /// Reserved, must be zero.
  ///
  PXE_UINT16    reserved;
} PXE_CPB_TRANSMIT;

typedef struct s_pxe_cpb_transmit_fragments {
  ///
  /// Length of packet data in bytes (not including the media header).
  ///
  PXE_UINT32    FrameLen;

  ///
  /// Length of the media header in bytes.
  ///
  PXE_UINT16    MediaheaderLen;

  ///
  /// Number of packet fragment descriptors.
  ///
  PXE_UINT16    FragCnt;

  ///
  /// Array of frame fragment descriptors.  The first byte of the first

    ///
    /// Address of this frame fragment.
    ///
    PXE_UINT64    FragAddr;

    ///
    /// Length of this frame fragment.
    ///
    PXE_UINT32    FragLen;

    ///
    /// Reserved, must be set to zero.
    ///
    PXE_UINT32    reserved;
  } FragDesc[MAX_XMIT_FRAGMENTS];
} PXE_CPB_TRANSMIT_FRAGMENTS;
PXE_CPB_TRANSMIT_FRAGMENTS;

typedef struct s_pxe_cpb_receive {
  ///
  /// Address of first byte of receive buffer.  This is also the first byte
  /// of the frame header.
  ///
  PXE_UINT64    BufferAddr;

  ///
  /// Length of receive buffer.  This must be large enough to hold the
  /// received frame (media header + data).  If the length of smaller than
  /// the received frame, data will be lost.
  ///
  PXE_UINT32    BufferLen;

  ///
  /// Reserved, must be set to zero.
  ///
  PXE_UINT32    reserved;
} PXE_CPB_RECEIVE;

typedef struct s_pxe_db_receive {
  ///
  /// Source and destination MAC addresses from media header.
  ///
  PXE_MAC_ADDR          SrcAddr;
  PXE_MAC_ADDR          DestAddr;

  ///
  /// Length of received frame.  May be larger than receive buffer size.
  /// The receive buffer will not be overwritten.  This is how to tell
  /// if data was lost because the receive buffer was too small.
  ///
  PXE_UINT32            FrameLen;

  ///
  /// Protocol type from media header.
  ///
  PXE_MEDIA_PROTOCOL    Protocol;

  ///
  /// Length of media header in received frame.
  ///
  PXE_UINT16            MediaHeaderLen;

  ///
  /// Type of receive frame.
  ///
  PXE_FRAME_TYPE        Type;

  ///
  /// Reserved, must be zero.
  ///
  PXE_UINT8             reserved[7];

} PXE_DB_RECEIVE;

#pragma pack()




  If a code construct is defined in the UEFI 2.7 specification it must be included
  by this include file.

Copyright (c) 2006 - 2021, Intel Corporation. All rights reserved.<BR>
Portions Copyright (c) 2020, Hewlett Packard Enterprise Development LP. All rights reserved.<BR>
Copyright (c) 2022, Loongson Technology Corporation Limited. All rights reserved.<BR>

SPDX-License-Identifier: BSD-2-Clause-Patent


//
// Memory cacheability attributes
//
#define EFI_MEMORY_UC   0x0000000000000001ULL
#define EFI_MEMORY_WC   0x0000000000000002ULL
#define EFI_MEMORY_WT   0x0000000000000004ULL
#define EFI_MEMORY_WB   0x0000000000000008ULL
#define EFI_MEMORY_UCE  0x0000000000000010ULL
//
// Physical memory protection attributes
//
// Note: UEFI spec 2.5 and following: use EFI_MEMORY_RO as write-protected physical memory
// protection attribute. Also, EFI_MEMORY_WP means cacheability attribute.
//
#define EFI_MEMORY_WP  0x0000000000001000ULL
#define EFI_MEMORY_RP  0x0000000000002000ULL
#define EFI_MEMORY_XP  0x0000000000004000ULL
#define EFI_MEMORY_RO  0x0000000000020000ULL
//
// Physical memory persistence attribute.
// The memory region supports byte-addressable non-volatility.
//
#define EFI_MEMORY_NV  0x0000000000008000ULL
//
// The memory region provides higher reliability relative to other memory in the system.
// If all memory has the same reliability, then this bit is not used.
//
#define EFI_MEMORY_MORE_RELIABLE  0x0000000000010000ULL

//
// Note: UEFI spec 2.8 and following:

// The SPM attribute serves as a hint to the OS to avoid allocating this
// memory for core OS data or code that can not be relocated.
//
#define EFI_MEMORY_SP  0x0000000000040000ULL
//
// If this flag is set, the memory region is capable of being
// protected with the CPU's memory cryptographic
// capabilities. If this flag is clear, the memory region is not
// capable of being protected with the CPU's memory
// cryptographic capabilities or the CPU does not support CPU
// memory cryptographic capabilities.
//
#define EFI_MEMORY_CPU_CRYPTO  0x0000000000080000ULL

//
// Runtime memory attribute
//
#define EFI_MEMORY_RUNTIME  0x8000000000000000ULL

//
// If this flag is set, the memory region is
// described with additional ISA-specific memory attributes
// as specified in EFI_MEMORY_ISA_MASK.
//
#define EFI_MEMORY_ISA_VALID  0x4000000000000000ULL

//
// Defines the bits reserved for describing optional ISA-specific cacheability
// attributes that are not covered by the standard UEFI Memory Attributes cacheability
// bits (EFI_MEMORY_UC, EFI_MEMORY_WC, EFI_MEMORY_WT, EFI_MEMORY_WB and EFI_MEMORY_UCE).
// See Calling Conventions for further ISA-specific enumeration of these bits.
//
#define EFI_MEMORY_ISA_MASK  0x0FFFF00000000000ULL

//
// Attributes bitmasks, grouped by type
//
#define EFI_CACHE_ATTRIBUTE_MASK   (EFI_MEMORY_UC | EFI_MEMORY_WC | EFI_MEMORY_WT | EFI_MEMORY_WB | EFI_MEMORY_UCE | EFI_MEMORY_WP)
#define EFI_MEMORY_ACCESS_MASK     (EFI_MEMORY_RP | EFI_MEMORY_XP | EFI_MEMORY_RO)
#define EFI_MEMORY_ATTRIBUTE_MASK  (EFI_MEMORY_ACCESS_MASK | EFI_MEMORY_SP | EFI_MEMORY_CPU_CRYPTO)

///
/// Memory descriptor version number.
///
#define EFI_MEMORY_DESCRIPTOR_VERSION  1

///
/// Definition of an EFI memory descriptor.

  /// Type EFI_MEMORY_TYPE is defined in the
  /// AllocatePages() function description.
  ///
  UINT32                  Type;
  ///
  /// Physical address of the first byte in the memory region. PhysicalStart must be
  /// aligned on a 4 KiB boundary, and must not be above 0xfffffffffffff000. Type
  /// EFI_PHYSICAL_ADDRESS is defined in the AllocatePages() function description
  ///
  EFI_PHYSICAL_ADDRESS    PhysicalStart;
  ///
  /// Virtual address of the first byte in the memory region.
  /// VirtualStart must be aligned on a 4 KiB boundary,
  /// and must not be above 0xfffffffffffff000.
  ///
  EFI_VIRTUAL_ADDRESS     VirtualStart;
  ///
  /// NumberOfPagesNumber of 4 KiB pages in the memory region.
  /// NumberOfPages must not be 0, and must not be any value
  /// that would represent a memory page with a start address,
  /// either physical or virtual, above 0xfffffffffffff000.
  ///
  UINT64                  NumberOfPages;
  ///
  /// Attributes of the memory region that describe the bit mask of capabilities
  /// for that memory region, and not necessarily the current settings for that
  /// memory region.
  ///
  UINT64                  Attribute;
} EFI_MEMORY_DESCRIPTOR;

/**

                                map that requires a mapping.
  @retval EFI_NOT_FOUND         A virtual address was supplied for an address that is not found
                                in the memory map.
  @retval EFI_UNSUPPORTED       This call is not supported by this platform at the time the call is made.
                                The platform should describe this runtime service as unsupported at runtime
                                via an EFI_RT_PROPERTIES_TABLE configuration table.

**/
typedef

EFI_STATUS
(EFIAPI *EFI_CONNECT_CONTROLLER)(
  IN  EFI_HANDLE                    ControllerHandle,
  IN  EFI_HANDLE                    *DriverImageHandle    OPTIONAL,
  IN  EFI_DEVICE_PATH_PROTOCOL      *RemainingDevicePath  OPTIONAL,
  IN  BOOLEAN                       Recursive
  );


EFI_STATUS
(EFIAPI *EFI_DISCONNECT_CONTROLLER)(
  IN  EFI_HANDLE                     ControllerHandle,
  IN  EFI_HANDLE                     DriverImageHandle  OPTIONAL,
  IN  EFI_HANDLE                     ChildHandle        OPTIONAL
  );



//
// ConvertPointer DebugDisposition type.
//
#define EFI_OPTIONAL_PTR  0x00000001

/**
  Determines the new virtual address that is to be used on subsequent memory accesses.

                                     for the new virtual address mappings being applied.

  @retval EFI_SUCCESS           The pointer pointed to by Address was modified.
  @retval EFI_INVALID_PARAMETER 1) Address is NULL.
                                2) *Address is NULL and DebugDisposition does
                                not have the EFI_OPTIONAL_PTR bit set.
  @retval EFI_NOT_FOUND         The pointer pointed to by Address was not found to be part
                                of the current memory map. This is normally fatal.
  @retval EFI_INVALID_PARAMETER Address is NULL.
  @retval EFI_INVALID_PARAMETER *Address is NULL and DebugDisposition does
                                not have the EFI_OPTIONAL_PTR bit set.
  @retval EFI_UNSUPPORTED       This call is not supported by this platform at the time the call is made.
                                The platform should describe this runtime service as unsupported at runtime
                                via an EFI_RT_PROPERTIES_TABLE configuration table.

**/
typedef

  IN OUT VOID                       **Address
  );


//
// These types can be ORed together as needed - for example,
// EVT_TIMER might be Ored with EVT_NOTIFY_WAIT or
// EVT_NOTIFY_SIGNAL.
//
#define EVT_TIMER          0x80000000
#define EVT_RUNTIME        0x40000000
#define EVT_NOTIFY_WAIT    0x00000100
#define EVT_NOTIFY_SIGNAL  0x00000200

#define EVT_SIGNAL_EXIT_BOOT_SERVICES      0x00000201
#define EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE  0x60000202

//
// The event's NotifyContext pointer points to a runtime memory
// address.
// The event is deprecated in UEFI2.0 and later specifications.
//
#define EVT_RUNTIME_CONTEXT  0x20000000


/**
  Invoke a notification event

(EFIAPI *EFI_CREATE_EVENT)(
  IN  UINT32                       Type,
  IN  EFI_TPL                      NotifyTpl,
  IN  EFI_EVENT_NOTIFY             NotifyFunction OPTIONAL,
  IN  VOID                         *NotifyContext OPTIONAL,
  OUT EFI_EVENT                    *Event
  );


  IN EFI_EVENT                Event
  );


//
// Task priority level
//
#define TPL_APPLICATION  4
#define TPL_CALLBACK     8
#define TPL_NOTIFY       16
#define TPL_HIGH_LEVEL   31


/**
  Raises a task's priority level and returns its previous level.

  @retval EFI_INVALID_PARAMETER  The DataSize is not too small and Data is NULL.
  @retval EFI_DEVICE_ERROR       The variable could not be retrieved due to a hardware error.
  @retval EFI_SECURITY_VIOLATION The variable could not be retrieved due to an authentication failure.
  @retval EFI_UNSUPPORTED        After ExitBootServices() has been called, this return code may be returned
                                 if no variable storage is supported. The platform should describe this
                                 runtime service as unsupported at runtime via an EFI_RT_PROPERTIES_TABLE
                                 configuration table.

**/
typedef

(EFIAPI *EFI_GET_VARIABLE)(
  IN     CHAR16                      *VariableName,
  IN     EFI_GUID                    *VendorGuid,
  OUT    UINT32                      *Attributes     OPTIONAL,
  IN OUT UINTN                       *DataSize,
  OUT    VOID                        *Data           OPTIONAL
  );

  @retval EFI_INVALID_PARAMETER Null-terminator is not found in the first VariableNameSize bytes of
                                the input VariableName buffer.
  @retval EFI_DEVICE_ERROR      The variable could not be retrieved due to a hardware error.
  @retval EFI_UNSUPPORTED       After ExitBootServices() has been called, this return code may be returned
                                if no variable storage is supported. The platform should describe this
                                runtime service as unsupported at runtime via an EFI_RT_PROPERTIES_TABLE
                                configuration table.

**/
typedef

                                 but the AuthInfo does NOT pass the validation check carried out by the firmware.

  @retval EFI_NOT_FOUND          The variable trying to be updated or deleted was not found.
  @retval EFI_UNSUPPORTED        This call is not supported by this platform at the time the call is made.
                                 The platform should describe this runtime service as unsupported at runtime
                                 via an EFI_RT_PROPERTIES_TABLE configuration table.

**/
typedef

  IN  VOID                         *Data
  );


///
/// This provides the capabilities of the
/// real time clock device as exposed through the EFI interfaces.

  /// value would be 1 Hz, or 1, to indicate that the device only reports
  /// the time to the resolution of 1 second.
  ///
  UINT32     Resolution;
  ///
  /// Provides the timekeeping accuracy of the real-time clock in an
  /// error rate of 1E-6 parts per million. For a clock with an accuracy
  /// of 50 parts per million, the value in this field would be
  /// 50,000,000.
  ///
  UINT32     Accuracy;
  ///
  /// A TRUE indicates that a time set operation clears the device's
  /// time below the Resolution reporting level. A FALSE

  /// device is not cleared when the time is set. Normal PC-AT CMOS
  /// RTC devices set this value to FALSE.
  ///
  BOOLEAN    SetsToZero;
} EFI_TIME_CAPABILITIES;

/**

  @retval EFI_SUCCESS           The operation completed successfully.
  @retval EFI_INVALID_PARAMETER Time is NULL.
  @retval EFI_DEVICE_ERROR      The time could not be retrieved due to hardware error.
  @retval EFI_UNSUPPORTED       This call is not supported by this platform at the time the call is made.
                                The platform should describe this runtime service as unsupported at runtime
                                via an EFI_RT_PROPERTIES_TABLE configuration table.

**/
typedef

  @retval EFI_SUCCESS           The operation completed successfully.
  @retval EFI_INVALID_PARAMETER A time field is out of range.
  @retval EFI_DEVICE_ERROR      The time could not be set due due to hardware error.
  @retval EFI_UNSUPPORTED       This call is not supported by this platform at the time the call is made.
                                The platform should describe this runtime service as unsupported at runtime
                                via an EFI_RT_PROPERTIES_TABLE configuration table.

**/
typedef

  @retval EFI_INVALID_PARAMETER Pending is NULL.
  @retval EFI_INVALID_PARAMETER Time is NULL.
  @retval EFI_DEVICE_ERROR      The wakeup time could not be retrieved due to a hardware error.
  @retval EFI_UNSUPPORTED       This call is not supported by this platform at the time the call is made.
                                The platform should describe this runtime service as unsupported at runtime
                                via an EFI_RT_PROPERTIES_TABLE configuration table.

**/
typedef

                                Enable is FALSE, then the wakeup alarm was disabled.
  @retval EFI_INVALID_PARAMETER A time field is out of range.
  @retval EFI_DEVICE_ERROR      The wakeup time could not be set due to a hardware error.
  @retval EFI_UNSUPPORTED       This call is not supported by this platform at the time the call is made.
                                The platform should describe this runtime service as unsupported at runtime
                                via an EFI_RT_PROPERTIES_TABLE configuration table.

**/
typedef

(EFIAPI *EFI_IMAGE_LOAD)(
  IN  BOOLEAN                      BootPolicy,
  IN  EFI_HANDLE                   ParentImageHandle,
  IN  EFI_DEVICE_PATH_PROTOCOL     *DevicePath   OPTIONAL,
  IN  VOID                         *SourceBuffer OPTIONAL,
  IN  UINTN                        SourceSize,
  OUT EFI_HANDLE                   *ImageHandle

  @retval EFI_SUCCESS           The next high monotonic count was returned.
  @retval EFI_INVALID_PARAMETER HighCount is NULL.
  @retval EFI_DEVICE_ERROR      The device is not functioning properly.
  @retval EFI_UNSUPPORTED       This call is not supported by this platform at the time the call is made.
                                The platform should describe this runtime service as unsupported at runtime
                                via an EFI_RT_PROPERTIES_TABLE configuration table.

**/
typedef

  OUT VOID                     **Interface
  );

#define EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL   0x00000001
#define EFI_OPEN_PROTOCOL_GET_PROTOCOL         0x00000002
#define EFI_OPEN_PROTOCOL_TEST_PROTOCOL        0x00000004
#define EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER  0x00000008
#define EFI_OPEN_PROTOCOL_BY_DRIVER            0x00000010
#define EFI_OPEN_PROTOCOL_EXCLUSIVE            0x00000020

/**
  Queries a handle to determine if it supports a specified protocol. If the protocol is supported by the

(EFIAPI *EFI_OPEN_PROTOCOL)(
  IN  EFI_HANDLE                Handle,
  IN  EFI_GUID                  *Protocol,
  OUT VOID                      **Interface  OPTIONAL,
  IN  EFI_HANDLE                AgentHandle,
  IN  EFI_HANDLE                ControllerHandle,
  IN  UINT32                    Attributes
  );


/**
  Closes a protocol on a handle that was opened using OpenProtocol().


/// EFI Oprn Protocol Information Entry
///
typedef struct {
  EFI_HANDLE    AgentHandle;
  EFI_HANDLE    ControllerHandle;
  UINT32        Attributes;
  UINT32        OpenCount;
} EFI_OPEN_PROTOCOL_INFORMATION_ENTRY;

/**

EFI_STATUS
(EFIAPI *EFI_LOCATE_HANDLE)(
  IN     EFI_LOCATE_SEARCH_TYPE   SearchType,
  IN     EFI_GUID                 *Protocol     OPTIONAL,
  IN     VOID                     *SearchKey    OPTIONAL,
  IN OUT UINTN                    *BufferSize,
  OUT    EFI_HANDLE               *Buffer
  );

EFI_STATUS
(EFIAPI *EFI_LOCATE_HANDLE_BUFFER)(
  IN     EFI_LOCATE_SEARCH_TYPE       SearchType,
  IN     EFI_GUID                     *Protocol       OPTIONAL,
  IN     VOID                         *SearchKey      OPTIONAL,
  OUT    UINTN                        *NoHandles,
  OUT    EFI_HANDLE                   **Buffer
  );

EFI_STATUS
(EFIAPI *EFI_LOCATE_PROTOCOL)(
  IN  EFI_GUID  *Protocol,
  IN  VOID      *Registration  OPTIONAL,
  OUT VOID      **Interface
  );


  ///
  /// Length in bytes of the data pointed to by DataBlock/ContinuationPointer.
  ///
  UINT64    Length;
  union {
    ///
    /// Physical address of the data block. This member of the union is
    /// used if Length is not equal to zero.
    ///
    EFI_PHYSICAL_ADDRESS    DataBlock;
    ///
    /// Physical address of another block of
    /// EFI_CAPSULE_BLOCK_DESCRIPTOR structures. This
    /// member of the union is used if Length is equal to zero. If
    /// ContinuationPointer is zero this entry represents the end of the list.
    ///
    EFI_PHYSICAL_ADDRESS    ContinuationPointer;
  } Union;
} EFI_CAPSULE_BLOCK_DESCRIPTOR;


  ///
  /// A GUID that defines the contents of a capsule.
  ///
  EFI_GUID    CapsuleGuid;
  ///
  /// The size of the capsule header. This may be larger than the size of
  /// the EFI_CAPSULE_HEADER since CapsuleGuid may imply
  /// extended header entries
  ///
  UINT32      HeaderSize;
  ///
  /// Bit-mapped list describing the capsule attributes. The Flag values
  /// of 0x0000 - 0xFFFF are defined by CapsuleGuid. Flag values
  /// of 0x10000 - 0xFFFFFFFF are defined by this specification
  ///
  UINT32      Flags;
  ///
  /// Size in bytes of the capsule (including capsule header).
  ///
  UINT32      CapsuleImageSize;
} EFI_CAPSULE_HEADER;

///

  ///
  /// the size of the array of capsules.
  ///
  UINT32    CapsuleArrayNumber;
  ///
  /// Point to an array of capsules that contain the same CapsuleGuid value.
  ///
  VOID      *CapsulePtr[1];
} EFI_CAPSULE_TABLE;

#define CAPSULE_FLAGS_PERSIST_ACROSS_RESET   0x00010000
#define CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE  0x00020000
#define CAPSULE_FLAGS_INITIATE_RESET         0x00040000

/**
  Passes capsules to the firmware with both virtual and physical mapping. Depending on the intended

                                in runtime. The caller may resubmit the capsule prior to ExitBootServices().
  @retval EFI_OUT_OF_RESOURCES  When ExitBootServices() has not been previously called then this error indicates
                                the capsule is compatible with this platform but there are insufficient resources to process.
  @retval EFI_UNSUPPORTED       This call is not supported by this platform at the time the call is made.
                                The platform should describe this runtime service as unsupported at runtime
                                via an EFI_RT_PROPERTIES_TABLE configuration table.

**/
typedef

                                in runtime. The caller may resubmit the capsule prior to ExitBootServices().
  @retval EFI_OUT_OF_RESOURCES  When ExitBootServices() has not been previously called then this error indicates
                                the capsule is compatible with this platform but there are insufficient resources to process.
  @retval EFI_UNSUPPORTED       This call is not supported by this platform at the time the call is made.
                                The platform should describe this runtime service as unsupported at runtime
                                via an EFI_RT_PROPERTIES_TABLE configuration table.

**/
typedef

  ///
  /// The table header for the EFI Runtime Services Table.
  ///
  EFI_TABLE_HEADER                  Hdr;

  //
  // Time Services
  //
  EFI_GET_TIME                      GetTime;
  EFI_SET_TIME                      SetTime;
  EFI_GET_WAKEUP_TIME               GetWakeupTime;
  EFI_SET_WAKEUP_TIME               SetWakeupTime;

  //
  // Virtual Memory Services
  //
  EFI_SET_VIRTUAL_ADDRESS_MAP       SetVirtualAddressMap;
  EFI_CONVERT_POINTER               ConvertPointer;

  //
  // Variable Services
  //
  EFI_GET_VARIABLE                  GetVariable;
  EFI_GET_NEXT_VARIABLE_NAME        GetNextVariableName;
  EFI_SET_VARIABLE                  SetVariable;

  //
  // Miscellaneous Services
  //
  EFI_GET_NEXT_HIGH_MONO_COUNT      GetNextHighMonotonicCount;
  EFI_RESET_SYSTEM                  ResetSystem;

  //
  // UEFI 2.0 Capsule Services
  //
  EFI_UPDATE_CAPSULE                UpdateCapsule;
  EFI_QUERY_CAPSULE_CAPABILITIES    QueryCapsuleCapabilities;

  //
  // Miscellaneous UEFI 2.0 Service
  //
  EFI_QUERY_VARIABLE_INFO           QueryVariableInfo;
} EFI_RUNTIME_SERVICES;

#define EFI_BOOT_SERVICES_SIGNATURE  SIGNATURE_64 ('B','O','O','T','S','E','R','V')
#define EFI_BOOT_SERVICES_REVISION   EFI_SPECIFICATION_VERSION
#define EFI_BOOT_SERVICES_REVISION    EFI_SPECIFICATION_VERSION

///
/// EFI Boot Services Table.

  ///
  /// The table header for the EFI Boot Services Table.
  ///
  EFI_TABLE_HEADER                              Hdr;

  //
  // Task Priority Services
  //
  EFI_RAISE_TPL                                 RaiseTPL;
  EFI_RESTORE_TPL                               RestoreTPL;

  //
  // Memory Services
  //
  EFI_ALLOCATE_PAGES                            AllocatePages;
  EFI_FREE_PAGES                                FreePages;
  EFI_GET_MEMORY_MAP                            GetMemoryMap;
  EFI_ALLOCATE_POOL                             AllocatePool;
  EFI_FREE_POOL                                 FreePool;

  //
  // Event & Timer Services
  //
  EFI_CREATE_EVENT                              CreateEvent;
  EFI_SET_TIMER                                 SetTimer;
  EFI_WAIT_FOR_EVENT                            WaitForEvent;
  EFI_SIGNAL_EVENT                              SignalEvent;
  EFI_CLOSE_EVENT                               CloseEvent;
  EFI_CHECK_EVENT                               CheckEvent;

  //
  // Protocol Handler Services
  //
  EFI_INSTALL_PROTOCOL_INTERFACE                InstallProtocolInterface;
  EFI_REINSTALL_PROTOCOL_INTERFACE              ReinstallProtocolInterface;
  EFI_UNINSTALL_PROTOCOL_INTERFACE              UninstallProtocolInterface;
  EFI_HANDLE_PROTOCOL                           HandleProtocol;
  VOID                                          *Reserved;
  EFI_REGISTER_PROTOCOL_NOTIFY                  RegisterProtocolNotify;
  EFI_LOCATE_HANDLE                             LocateHandle;
  EFI_LOCATE_DEVICE_PATH                        LocateDevicePath;
  EFI_INSTALL_CONFIGURATION_TABLE               InstallConfigurationTable;

  //
  // Image Services
  //
  EFI_IMAGE_LOAD                                LoadImage;
  EFI_IMAGE_START                               StartImage;
  EFI_EXIT                                      Exit;
  EFI_IMAGE_UNLOAD                              UnloadImage;
  EFI_EXIT_BOOT_SERVICES                        ExitBootServices;

  //
  // Miscellaneous Services
  //
  EFI_GET_NEXT_MONOTONIC_COUNT                  GetNextMonotonicCount;
  EFI_STALL                                     Stall;
  EFI_SET_WATCHDOG_TIMER                        SetWatchdogTimer;

  //
  // DriverSupport Services
  //
  EFI_CONNECT_CONTROLLER                        ConnectController;
  EFI_DISCONNECT_CONTROLLER                     DisconnectController;

  //
  // Open and Close Protocol Services
  //
  EFI_OPEN_PROTOCOL                             OpenProtocol;
  EFI_CLOSE_PROTOCOL                            CloseProtocol;
  EFI_OPEN_PROTOCOL_INFORMATION                 OpenProtocolInformation;

  //
  // Library Services
  //
  EFI_PROTOCOLS_PER_HANDLE                      ProtocolsPerHandle;
  EFI_LOCATE_HANDLE_BUFFER                      LocateHandleBuffer;
  EFI_LOCATE_PROTOCOL                           LocateProtocol;
  EFI_INSTALL_MULTIPLE_PROTOCOL_INTERFACES      InstallMultipleProtocolInterfaces;
  EFI_UNINSTALL_MULTIPLE_PROTOCOL_INTERFACES    UninstallMultipleProtocolInterfaces;

  //
  // 32-bit CRC Services
  //
  EFI_CALCULATE_CRC32                           CalculateCrc32;

  //
  // Miscellaneous Services
  //
  EFI_COPY_MEM                                  CopyMem;
  EFI_SET_MEM                                   SetMem;
  EFI_CREATE_EVENT_EX                           CreateEventEx;
} EFI_BOOT_SERVICES;

///

  ///
  /// The 128-bit GUID value that uniquely identifies the system configuration table.
  ///
  EFI_GUID    VendorGuid;
  ///
  /// A pointer to the table associated with VendorGuid.
  ///
  VOID        *VendorTable;
} EFI_CONFIGURATION_TABLE;

///

  ///
  /// The table header for the EFI System Table.
  ///
  EFI_TABLE_HEADER                   Hdr;
  ///
  /// A pointer to a null terminated string that identifies the vendor
  /// that produces the system firmware for the platform.
  ///
  CHAR16                             *FirmwareVendor;
  ///
  /// A firmware vendor specific value that identifies the revision
  /// of the system firmware for the platform.
  ///
  UINT32                             FirmwareRevision;
  ///
  /// The handle for the active console input device. This handle must support
  /// EFI_SIMPLE_TEXT_INPUT_PROTOCOL and EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL. If
  /// there is no active console, these protocols must still be present.
  ///
  EFI_HANDLE                         ConsoleInHandle;
  ///
  /// A pointer to the EFI_SIMPLE_TEXT_INPUT_PROTOCOL interface that is
  /// associated with ConsoleInHandle.
  ///
  EFI_SIMPLE_TEXT_INPUT_PROTOCOL     *ConIn;
  ///
  /// The handle for the active console output device. This handle must support the
  /// EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL. If there is no active console, these protocols
  /// must still be present.
  ///
  EFI_HANDLE                         ConsoleOutHandle;
  ///
  /// A pointer to the EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL interface
  /// that is associated with ConsoleOutHandle.
  ///
  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL    *ConOut;
  ///
  /// The handle for the active standard error console device.
  /// This handle must support the EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL. If there
  /// is no active console, this protocol must still be present.
  ///
  EFI_HANDLE                         StandardErrorHandle;
  ///
  /// A pointer to the EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL interface
  /// that is associated with StandardErrorHandle.
  ///
  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL    *StdErr;
  ///
  /// A pointer to the EFI Runtime Services Table.
  ///
  EFI_RUNTIME_SERVICES               *RuntimeServices;
  ///
  /// A pointer to the EFI Boot Services Table.
  ///
  EFI_BOOT_SERVICES                  *BootServices;
  ///
  /// The number of system configuration tables in the buffer ConfigurationTable.
  ///
  UINTN                              NumberOfTableEntries;
  ///
  /// A pointer to the system configuration tables.
  /// The number of entries in the table is NumberOfTableEntries.
  ///
  EFI_CONFIGURATION_TABLE            *ConfigurationTable;
} EFI_SYSTEM_TABLE;

/**

  /// The attributes for this load option entry. All unused bits must be zero
  /// and are reserved by the UEFI specification for future growth.
  ///
  UINT32    Attributes;
  ///
  /// Length in bytes of the FilePathList. OptionalData starts at offset
  /// sizeof(UINT32) + sizeof(UINT16) + StrSize(Description) + FilePathListLength
  /// of the EFI_LOAD_OPTION descriptor.
  ///
  UINT16    FilePathListLength;
  ///
  /// The user readable description for the load option.
  /// This field ends with a Null character.

//
// EFI Load Options Attributes
//
#define LOAD_OPTION_ACTIVE           0x00000001
#define LOAD_OPTION_FORCE_RECONNECT  0x00000002
#define LOAD_OPTION_HIDDEN           0x00000008
#define LOAD_OPTION_CATEGORY         0x00001F00

#define LOAD_OPTION_CATEGORY_BOOT  0x00000000
#define LOAD_OPTION_CATEGORY_APP   0x00000100

#define EFI_BOOT_OPTION_SUPPORT_KEY      0x00000001
#define EFI_BOOT_OPTION_SUPPORT_APP      0x00000002
#define EFI_BOOT_OPTION_SUPPORT_SYSPREP  0x00000010
#define EFI_BOOT_OPTION_SUPPORT_COUNT    0x00000300

///
/// EFI Boot Key Data

    ///
    /// Indicates the revision of the EFI_KEY_OPTION structure. This revision level should be 0.
    ///
    UINT32    Revision       : 8;
    ///
    /// Either the left or right Shift keys must be pressed (1) or must not be pressed (0).
    ///
    UINT32    ShiftPressed   : 1;
    ///
    /// Either the left or right Control keys must be pressed (1) or must not be pressed (0).
    ///
    UINT32    ControlPressed : 1;
    ///
    /// Either the left or right Alt keys must be pressed (1) or must not be pressed (0).
    ///
    UINT32    AltPressed     : 1;
    ///
    /// Either the left or right Logo keys must be pressed (1) or must not be pressed (0).
    ///
    UINT32    LogoPressed    : 1;
    ///
    /// The Menu key must be pressed (1) or must not be pressed (0).
    ///
    UINT32    MenuPressed    : 1;
    ///
    /// The SysReq key must be pressed (1) or must not be pressed (0).
    ///
    UINT32    SysReqPressed  : 1;
    UINT32    Reserved       : 16;
    ///
    /// Specifies the actual number of entries in EFI_KEY_OPTION.Keys, from 0-3. If
    /// zero, then only the shift state is considered. If more than one, then the boot option will
    /// only be launched if all of the specified keys are pressed with the same shift state.
    ///
    UINT32    InputKeyCount  : 2;
  } Options;
  UINT32    PackedValue;
} EFI_BOOT_KEY_DATA;

///

  ///
  /// Specifies options about how the key will be processed.
  ///
  EFI_BOOT_KEY_DATA    KeyData;
  ///
  /// The CRC-32 which should match the CRC-32 of the entire EFI_LOAD_OPTION to
  /// which BootOption refers. If the CRC-32s do not match this value, then this key
  /// option is ignored.
  ///
  UINT32               BootOptionCrc;
  ///
  /// The Boot#### option which will be invoked if this key is pressed and the boot option
  /// is active (LOAD_OPTION_ACTIVE is set).
  ///
  UINT16               BootOption;
  ///
  /// The key codes to compare against those returned by the
  /// EFI_SIMPLE_TEXT_INPUT and EFI_SIMPLE_TEXT_INPUT_EX protocols.
  /// The number of key codes (0-3) is specified by the EFI_KEY_CODE_COUNT field in KeyOptions.
  ///
  // EFI_INPUT_KEY      Keys[];
} EFI_KEY_OPTION;
#pragma pack()

//
// EFI File location to boot from on removable media devices
//
#define EFI_REMOVABLE_MEDIA_FILE_NAME_IA32         L"\\EFI\\BOOT\\BOOTIA32.EFI"
#define EFI_REMOVABLE_MEDIA_FILE_NAME_IA64         L"\\EFI\\BOOT\\BOOTIA64.EFI"
#define EFI_REMOVABLE_MEDIA_FILE_NAME_X64          L"\\EFI\\BOOT\\BOOTX64.EFI"
#define EFI_REMOVABLE_MEDIA_FILE_NAME_ARM          L"\\EFI\\BOOT\\BOOTARM.EFI"
#define EFI_REMOVABLE_MEDIA_FILE_NAME_AARCH64      L"\\EFI\\BOOT\\BOOTAA64.EFI"
#define EFI_REMOVABLE_MEDIA_FILE_NAME_RISCV64      L"\\EFI\\BOOT\\BOOTRISCV64.EFI"
#define EFI_REMOVABLE_MEDIA_FILE_NAME_LOONGARCH64  L"\\EFI\\BOOT\\BOOTLOONGARCH64.EFI"

#if !defined (EFI_REMOVABLE_MEDIA_FILE_NAME)
  #if   defined (MDE_CPU_IA32)
#define EFI_REMOVABLE_MEDIA_FILE_NAME  EFI_REMOVABLE_MEDIA_FILE_NAME_IA32
  #elif defined (MDE_CPU_X64)
#define EFI_REMOVABLE_MEDIA_FILE_NAME  EFI_REMOVABLE_MEDIA_FILE_NAME_X64
  #elif defined (MDE_CPU_EBC)
  #elif defined (MDE_CPU_ARM)
#define EFI_REMOVABLE_MEDIA_FILE_NAME  EFI_REMOVABLE_MEDIA_FILE_NAME_ARM
  #elif defined (MDE_CPU_AARCH64)
#define EFI_REMOVABLE_MEDIA_FILE_NAME  EFI_REMOVABLE_MEDIA_FILE_NAME_AARCH64
  #elif defined (MDE_CPU_RISCV64)
#define EFI_REMOVABLE_MEDIA_FILE_NAME  EFI_REMOVABLE_MEDIA_FILE_NAME_RISCV64
  #elif defined (MDE_CPU_LOONGARCH64)
#define EFI_REMOVABLE_MEDIA_FILE_NAME  EFI_REMOVABLE_MEDIA_FILE_NAME_LOONGARCH64
  #else
    #error Unknown Processor Type
  #endif
#endif

//
// The directory within the active EFI System Partition defined for delivery of capsule to firmware
//
#define EFI_CAPSULE_FILE_DIRECTORY  L"\\EFI\\UpdateCapsule\\"

#include <Uefi/UefiPxe.h>
#include <Uefi/UefiGpt.h>

Lines 4-12 Link Here

(-)b/sys/contrib/edk2/MdePkg.dec (-13 / +192 lines)
4	# It also provides the definitions(including PPIs/PROTOCOLs/GUIDs) of	4	# It also provides the definitions(including PPIs/PROTOCOLs/GUIDs) of
5	# EFI1.10/UEFI2.7/PI1.7 and some Industry Standards.	5	# EFI1.10/UEFI2.7/PI1.7 and some Industry Standards.
6	#	6	#
7	# Copyright (c) 2007 - 2019, Intel Corporation. All rights reserved.<BR>	7	# Copyright (c) 2007 - 2024, Intel Corporation. All rights reserved.<BR>
8	# Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>	8	# Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>
9	# (C) Copyright 2016 - 2020 Hewlett Packard Enterprise Development LP<BR>	9	# (C) Copyright 2016 - 2021 Hewlett Packard Enterprise Development LP<BR>
		10	# Copyright (c) 2022, Loongson Technology Corporation Limited. All rights reserved.<BR>
		11	# Copyright (c) 2021 - 2022, Arm Limited. All rights reserved.<BR>
		12	# Copyright (C) 2023 Advanced Micro Devices, Inc. All rights reserved.<BR>
		13	# Copyright (c) 2023, Ampere Computing LLC. All rights reserved.<BR>
10	#	14	#
11	# SPDX-License-Identifier: BSD-2-Clause-Patent	15	# SPDX-License-Identifier: BSD-2-Clause-Patent
12	#	16	#
Lines 23-28 Link Here
23		27
24	[Includes]	28	[Includes]
25	Include	29	Include
		30	Test/UnitTest/Include
		31	Test/Mock/Include
		32	Library/MipiSysTLib/mipisyst/library/include
26		33
27	[Includes.IA32]	34	[Includes.IA32]
28	Include/Ia32	35	Include/Ia32
Lines 42-47 Link Here
42	[Includes.RISCV64]	49	[Includes.RISCV64]
43	Include/RiscV64	50	Include/RiscV64
44		51
		52	[Includes.LOONGARCH64]
		53	Include/LoongArch64
		54
45	[LibraryClasses]	55	[LibraryClasses]
46	## @libraryclass Provides most usb APIs to support the Hid requests defined in Usb Hid 1.1 spec	56	## @libraryclass Provides most usb APIs to support the Hid requests defined in Usb Hid 1.1 spec
47	# and the standard requests defined in Usb 1.1 spec.	57	# and the standard requests defined in Usb 1.1 spec.
Lines 251-256 Link Here
251	#	261	#
252	UnitTestLib\|Include/Library/UnitTestLib.h	262	UnitTestLib\|Include/Library/UnitTestLib.h
253		263
		264	## @libraryclass Provides service to get the manufacturer given JEP106 bytes.
		265	JedecJep106Lib\|Include/Library/JedecJep106Lib.h
		266
		267	## @libraryclass Extension to BaseLib for host based unit tests that allows a
		268	# subset of BaseLib services to be hooked for emulation.
		269	#
		270	UnitTestHostBaseLib\|Test/UnitTest/Include/Library/UnitTestHostBaseLib.h
		271
		272	## @libraryclass This library provides an interface to request non-MMRAM pages to be mapped
		273	# or unblocked from inside MM environment.
		274	#
		275	MmUnblockMemoryLib\|Include/Library/MmUnblockMemoryLib.h
		276
		277	## @libraryclass This library provides interfances to filter and trace port IO/MMIO/MSR access.
		278	#
		279	#
		280	RegisterFilterLib\|Include/Library/RegisterFilterLib.h
		281
		282	## @libraryclass This library provides interfances to probe ConfidentialComputing guest type.
		283	#
		284	#
		285	CcProbeLib\|Include/Library/CcProbeLib.h
		286
		287	## @libraryclass Provides function for SMM CPU Rendezvous Library.
		288	SmmCpuRendezvousLib\|Include/Library/SmmCpuRendezvousLib.h
		289
		290	## @libraryclass Provides services to generate Entropy using a TRNG.
		291	#
		292	ArmTrngLib\|Include/Library/ArmTrngLib.h
		293
		294	## @libraryclass Provides APIs for third-party library libfdt.
		295	#
		296	FdtLib\|Include/Library/FdtLib.h
		297
		298	## @libraryclass Provides general mipi sys-T services.
		299	#
		300	MipiSysTLib\|Include/Library/MipiSysTLib.h
		301
		302	## @libraryclass Provides API to output Trace Hub debug message.
		303	#
		304	TraceHubDebugSysTLib\|Include/Library/TraceHubDebugSysTLib.h
		305
		306	[LibraryClasses.IA32, LibraryClasses.X64, LibraryClasses.AARCH64]
		307	## @libraryclass Provides services to generate random number.
		308	#
		309	RngLib\|Include/Library/RngLib.h
		310
254	[LibraryClasses.IA32, LibraryClasses.X64]	311	[LibraryClasses.IA32, LibraryClasses.X64]
255	## @libraryclass Abstracts both S/W SMI generation and detection.	312	## @libraryclass Abstracts both S/W SMI generation and detection.
256	##	313	##
Lines 272-284 Link Here
272	#	329	#
273	SmmPeriodicSmiLib\|Include/Library/SmmPeriodicSmiLib.h	330	SmmPeriodicSmiLib\|Include/Library/SmmPeriodicSmiLib.h
274		331
275	## @libraryclass Provides services to generate random number.
276	#
277	RngLib\|Include/Library/RngLib.h
278
279	## @libraryclass Provides services to log the SMI handler registration.	332	## @libraryclass Provides services to log the SMI handler registration.
280	SmiHandlerProfileLib\|Include/Library/SmiHandlerProfileLib.h	333	SmiHandlerProfileLib\|Include/Library/SmiHandlerProfileLib.h
281		334
		335	## @libraryclass Provides function to support TDX processing.
		336	TdxLib\|Include/Library/TdxLib.h
		337
		338	[LibraryClasses.RISCV64]
		339	## @libraryclass Provides function to make ecalls to SBI
		340	BaseRiscVSbiLib\|Include/Library/BaseRiscVSbiLib.h
		341
282	[Guids]	342	[Guids]
283	#	343	#
284	# GUID defined in UEFI2.1/UEFI2.0/EFI1.1	344	# GUID defined in UEFI2.1/UEFI2.0/EFI1.1
Lines 376-386 Link Here
376	## Include/Guid/EventGroup.h	436	## Include/Guid/EventGroup.h
377	gEfiEventReadyToBootGuid = { 0x7CE88FB3, 0x4BD7, 0x4679, { 0x87, 0xA8, 0xA8, 0xD8, 0xDE, 0xE5, 0x0D, 0x2B }}	437	gEfiEventReadyToBootGuid = { 0x7CE88FB3, 0x4BD7, 0x4679, { 0x87, 0xA8, 0xA8, 0xD8, 0xDE, 0xE5, 0x0D, 0x2B }}
378		438
		439	## Include/Guid/EventGroup.h
		440	gEfiEventAfterReadyToBootGuid = { 0x3a2a00ad, 0x98b9, 0x4cdf, { 0xa4, 0x78, 0x70, 0x27, 0x77, 0xf1, 0xc1, 0x0b }}
		441
379	## Include/Guid/EventGroup.h	442	## Include/Guid/EventGroup.h
380	gEfiEventMemoryMapChangeGuid = { 0x78BEE926, 0x692F, 0x48FD, { 0x9E, 0xDB, 0x01, 0x42, 0x2E, 0xF0, 0xD7, 0xAB }}	443	gEfiEventMemoryMapChangeGuid = { 0x78BEE926, 0x692F, 0x48FD, { 0x9E, 0xDB, 0x01, 0x42, 0x2E, 0xF0, 0xD7, 0xAB }}
381		444
382	## Include/Guid/EventGroup.h	445	## Include/Guid/EventGroup.h
383	gEfiEventVirtualAddressChangeGuid = { 0x13FA7698, 0xC831, 0x49C7, { 0x87, 0xEA, 0x8F, 0x43, 0xFC, 0xC2, 0x51, 0x96 }}	446	gEfiEventVirtualAddressChangeGuid = { 0x13FA7698, 0xC831, 0x49C7, { 0x87, 0xEA, 0x8F, 0x43, 0xFC, 0xC2, 0x51, 0x96 }}
		447
		448	## Include/Guid/EventGroup.h
		449	gEfiEventBeforeExitBootServicesGuid = { 0x8BE0E274, 0x3970, 0x4B44, { 0x80, 0xC5, 0x1A, 0xB9, 0x50, 0x2F, 0x3B, 0xFC }}
384		450
385	## Include/Guid/EventGroup.h	451	## Include/Guid/EventGroup.h
386	gEfiEventExitBootServicesGuid = { 0x27ABF055, 0xB1B8, 0x4C26, { 0x80, 0x48, 0x74, 0x8F, 0x37, 0xBA, 0xA2, 0xDF }}	452	gEfiEventExitBootServicesGuid = { 0x27ABF055, 0xB1B8, 0x4C26, { 0x80, 0x48, 0x74, 0x8F, 0x37, 0xBA, 0xA2, 0xDF }}
Lines 577-582 Link Here
577	gEfiRngAlgorithmX9313DesGuid = { 0x63c4785a, 0xca34, 0x4012, {0xa3, 0xc8, 0x0b, 0x6a, 0x32, 0x4f, 0x55, 0x46 }}	643	gEfiRngAlgorithmX9313DesGuid = { 0x63c4785a, 0xca34, 0x4012, {0xa3, 0xc8, 0x0b, 0x6a, 0x32, 0x4f, 0x55, 0x46 }}
578	gEfiRngAlgorithmX931AesGuid = { 0xacd03321, 0x777e, 0x4d3d, {0xb1, 0xc8, 0x20, 0xcf, 0xd8, 0x88, 0x20, 0xc9 }}	644	gEfiRngAlgorithmX931AesGuid = { 0xacd03321, 0x777e, 0x4d3d, {0xb1, 0xc8, 0x20, 0xcf, 0xd8, 0x88, 0x20, 0xc9 }}
579	gEfiRngAlgorithmRaw = { 0xe43176d7, 0xb6e8, 0x4827, {0xb7, 0x84, 0x7f, 0xfd, 0xc4, 0xb6, 0x85, 0x61 }}	645	gEfiRngAlgorithmRaw = { 0xe43176d7, 0xb6e8, 0x4827, {0xb7, 0x84, 0x7f, 0xfd, 0xc4, 0xb6, 0x85, 0x61 }}
		646	gEfiRngAlgorithmArmRndr = { 0x43d2fde3, 0x9d4e, 0x4d79, {0x02, 0x96, 0xa8, 0x9b, 0xca, 0x78, 0x08, 0x41 }}
580		647
581	## Include/Protocol/AdapterInformation.h	648	## Include/Protocol/AdapterInformation.h
582	gEfiAdapterInfoMediaStateGuid = { 0xD7C74207, 0xA831, 0x4A26, {0xB1, 0xF5, 0xD1, 0x93, 0x06, 0x5C, 0xE8, 0xB6 }}	649	gEfiAdapterInfoMediaStateGuid = { 0xD7C74207, 0xA831, 0x4A26, {0xB1, 0xF5, 0xD1, 0x93, 0x06, 0x5C, 0xE8, 0xB6 }}
Lines 663-675 Link Here
663	gEfiJsonCapsuleIdGuid = { 0x67d6f4cd, 0xd6b8, 0x4573, { 0xbf, 0x4a, 0xde, 0x5e, 0x25, 0x2d, 0x61, 0xae }}	730	gEfiJsonCapsuleIdGuid = { 0x67d6f4cd, 0xd6b8, 0x4573, { 0xbf, 0x4a, 0xde, 0x5e, 0x25, 0x2d, 0x61, 0xae }}
664		731
665	## Include/Guid/HiiPlatformSetupFormset.h	732	## Include/Guid/HiiPlatformSetupFormset.h
666	gEfiHiiResetStyleFormsetGuid = { 0x790217bd, 0xbecf, 0x485b, { 0x91, 0x70, 0x5f, 0xf7, 0x11, 0x31, 0x8b, 0x27 }}	733	gEfiHiiRestStyleFormsetGuid = { 0x790217bd, 0xbecf, 0x485b, { 0x91, 0x70, 0x5f, 0xf7, 0x11, 0x31, 0x8b, 0x27 }}
667		734
668	# GUIDs defined in UEFI2.8a	735	# GUIDs defined in UEFI2.8a
669	#	736	#
670	## Include/Guid/RtPropertiesTable.h	737	## Include/Guid/RtPropertiesTable.h
671	gEfiRtPropertiesTableGuid = { 0xeb66918a, 0x7eef, 0x402a, { 0x84, 0x2e, 0x93, 0x1d, 0x21, 0xc3, 0x8a, 0xe9 }}	738	gEfiRtPropertiesTableGuid = { 0xeb66918a, 0x7eef, 0x402a, { 0x84, 0x2e, 0x93, 0x1d, 0x21, 0xc3, 0x8a, 0xe9 }}
672		739
		740	## Include/Protocol/SerilaIo.h
		741	gEfiSerialTerminalDeviceTypeGuid = { 0x6AD9A60F, 0x5815, 0x4C7C, { 0x8A, 0x10, 0x50, 0x53, 0xD2, 0xBF, 0x7A, 0x1B }}
		742
		743	# GUIDs defined in UEFI2.10
		744	#
		745	## GUID used to specify section with devdb content
		746	## Include/Guid/DeviceAuthentication.h
		747	gEfiDeviceSignatureDatabaseGuid = { 0xb9c2b4f4, 0xbf5f, 0x462d, {0x8a, 0xdf, 0xc5, 0xc7, 0xa, 0xc3, 0x5d, 0xad }}
		748
673	#	749	#
674	# GUID defined in PI1.0	750	# GUID defined in PI1.0
675	#	751	#
Lines 798-803 Link Here
798	#	874	#
799	gTianoCustomDecompressGuid = { 0xA31280AD, 0x481E, 0x41B6, { 0x95, 0xE8, 0x12, 0x7F, 0x4C, 0x98, 0x47, 0x79 }}	875	gTianoCustomDecompressGuid = { 0xA31280AD, 0x481E, 0x41B6, { 0x95, 0xE8, 0x12, 0x7F, 0x4C, 0x98, 0x47, 0x79 }}
800		876
		877	#
		878	# GUID used to provide initrd to linux via LoadFile2 protocol
		879	#
		880	gLinuxEfiInitrdMediaGuid = {0x5568e427, 0x68fc, 0x4f3d, {0xac, 0x74, 0xca, 0x55, 0x52, 0x31, 0xcc, 0x68}}
		881
		882	## Include/Protocol/CcMeasurement.h
		883	gEfiCcFinalEventsTableGuid = { 0xdd4a4648, 0x2de7, 0x4665, { 0x96, 0x4d, 0x21, 0xd9, 0xef, 0x5f, 0xb4, 0x46 }}
		884
801	[Guids.IA32, Guids.X64]	885	[Guids.IA32, Guids.X64]
802	## Include/Guid/Cper.h	886	## Include/Guid/Cper.h
803	gEfiIa32X64ErrorTypeCacheCheckGuid = { 0xA55701F5, 0xE3EF, 0x43de, { 0xAC, 0x72, 0x24, 0x9B, 0x57, 0x3F, 0xAD, 0x2C }}	887	gEfiIa32X64ErrorTypeCacheCheckGuid = { 0xA55701F5, 0xE3EF, 0x43de, { 0xAC, 0x72, 0x24, 0x9B, 0x57, 0x3F, 0xAD, 0x2C }}
Lines 963-968 Link Here
963	## Include/Ppi/MmControl.h	1047	## Include/Ppi/MmControl.h
964	gEfiPeiMmControlPpiGuid = { 0x61c68702, 0x4d7e, 0x4f43, { 0x8d, 0xef, 0xa7, 0x43, 0x5, 0xce, 0x74, 0xc5 }}	1048	gEfiPeiMmControlPpiGuid = { 0x61c68702, 0x4d7e, 0x4f43, { 0x8d, 0xef, 0xa7, 0x43, 0x5, 0xce, 0x74, 0xc5 }}
965		1049
		1050	## Include/Ppi/MmConfiguration.h
		1051	gEfiPeiMmConfigurationPpi = { 0xc109319, 0xc149, 0x450e, { 0xa3, 0xe3, 0xb9, 0xba, 0xdd, 0x9d, 0xc3, 0xa4 } }
		1052
		1053	## Include/Ppi/MmCommunication.h
		1054	gEfiPeiMmCommunicationPpiGuid = { 0xae933e1c, 0xcc47, 0x4e38, { 0x8f, 0xe, 0xe2, 0xf6, 0x1d, 0x26, 0x5, 0xdf } }
		1055
966	#	1056	#
967	# PPIs defined in PI 1.7.	1057	# PPIs defined in PI 1.7.
968	#	1058	#
Lines 974-985 Link Here
974	gEfiPeiDelayedDispatchPpiGuid = { 0x869c711d, 0x649c, 0x44fe, { 0x8b, 0x9e, 0x2c, 0xbb, 0x29, 0x11, 0xc3, 0xe6 }}	1064	gEfiPeiDelayedDispatchPpiGuid = { 0x869c711d, 0x649c, 0x44fe, { 0x8b, 0x9e, 0x2c, 0xbb, 0x29, 0x11, 0xc3, 0xe6 }}
975		1065
976	[Protocols]	1066	[Protocols]
		1067	## Include/Protocol/MemoryAccept.h
		1068	gEdkiiMemoryAcceptProtocolGuid = { 0x38c74800, 0x5590, 0x4db4, { 0xa0, 0xf3, 0x67, 0x5d, 0x9b, 0x8e, 0x80, 0x26 }}
		1069
977	## Include/Protocol/Pcd.h	1070	## Include/Protocol/Pcd.h
978	gPcdProtocolGuid = { 0x11B34006, 0xD85B, 0x4D0A, { 0xA2, 0x90, 0xD5, 0xA5, 0x71, 0x31, 0x0E, 0xF7 }}	1071	gPcdProtocolGuid = { 0x11B34006, 0xD85B, 0x4D0A, { 0xA2, 0x90, 0xD5, 0xA5, 0x71, 0x31, 0x0E, 0xF7 }}
979		1072
980	## Include/Protocol/PcdInfo.h	1073	## Include/Protocol/PcdInfo.h
981	gGetPcdInfoProtocolGuid = { 0x5be40f57, 0xfa68, 0x4610, { 0xbb, 0xbf, 0xe9, 0xc5, 0xfc, 0xda, 0xd3, 0x65 } }	1074	gGetPcdInfoProtocolGuid = { 0x5be40f57, 0xfa68, 0x4610, { 0xbb, 0xbf, 0xe9, 0xc5, 0xfc, 0xda, 0xd3, 0x65 } }
982		1075
		1076	## Include/Protocol/CcMeasurement.h
		1077	gEfiCcMeasurementProtocolGuid = { 0x96751a3d, 0x72f4, 0x41a6, { 0xa7, 0x94, 0xed, 0x5d, 0x0e, 0x67, 0xae, 0x6b }}
		1078
983	#	1079	#
984	# Protocols defined in PI1.0.	1080	# Protocols defined in PI1.0.
985	#	1081	#
Lines 1839-1844 Link Here
1839	## Include/Protocol/NvdimmLabel.h	1935	## Include/Protocol/NvdimmLabel.h
1840	gEfiNvdimmLabelProtocolGuid = { 0xd40b6b80, 0x97d5, 0x4282, { 0xbb, 0x1d, 0x22, 0x3a, 0x16, 0x91, 0x80, 0x58 }}	1936	gEfiNvdimmLabelProtocolGuid = { 0xd40b6b80, 0x97d5, 0x4282, { 0xbb, 0x1d, 0x22, 0x3a, 0x16, 0x91, 0x80, 0x58 }}
1841		1937
		1938	#
		1939	# Protocols defined in UEFI2.8
		1940	#
		1941	## Include/Protocol/RestEx.h
		1942	gEfiRestExProtocolGuid = { 0x55648b91, 0xe7d, 0x40a3, { 0xa9, 0xb3, 0xa8, 0x15, 0xd7, 0xea, 0xdf, 0x97 }}
		1943	gEfiRestExServiceBindingProtocolGuid = { 0x456bbe01, 0x99d0, 0x45ea, { 0xbb, 0x5f, 0x16, 0xd8, 0x4b, 0xed, 0xc5, 0x59 }}
		1944
		1945	## Include/Protocol/RestJsonStructure.h
		1946	gEfiRestJsonStructureProtocolGuid = { 0xa9a048f6, 0x48a0, 0x4714, {0xb7, 0xda, 0xa9, 0xad,0x87, 0xd4, 0xda, 0xc9 }}
		1947
		1948	## Include/Protocol/RedfishDiscover.h
		1949	gEfiRedfishDiscoverProtocolGuid = { 0x5db12509, 0x4550, 0x4347, { 0x96, 0xb3, 0x73, 0xc0, 0xff, 0x6e, 0x86, 0x9f }}
		1950
		1951	## Include/Protocol/MemoryAttribute.h
		1952	gEfiMemoryAttributeProtocolGuid = { 0xf4560cf6, 0x40ec, 0x4b4a, { 0xa1, 0x92, 0xbf, 0x1d, 0x57, 0xd0, 0xb1, 0x89 }}
		1953
1842	#	1954	#
1843	# Protocols defined in Shell2.0	1955	# Protocols defined in Shell2.0
1844	#	1956	#
Lines 2107-2112 Link Here
2107	# BIT20 - Global Coherency Database changes message.<BR>	2219	# BIT20 - Global Coherency Database changes message.<BR>
2108	# BIT21 - Memory range cachability changes message.<BR>	2220	# BIT21 - Memory range cachability changes message.<BR>
2109	# BIT22 - Detailed debug message.<BR>	2221	# BIT22 - Detailed debug message.<BR>
		2222	# BIT23 - Manageability debug message.<BR>
2110	# BIT31 - Error message.<BR>	2223	# BIT31 - Error message.<BR>
2111	# @Prompt Fixed Debug Message Print Level.	2224	# @Prompt Fixed Debug Message Print Level.
2112	gEfiMdePkgTokenSpaceGuid.PcdFixedDebugPrintErrorLevel\|0xFFFFFFFF\|UINT32\|0x30001016	2225	gEfiMdePkgTokenSpaceGuid.PcdFixedDebugPrintErrorLevel\|0xFFFFFFFF\|UINT32\|0x30001016
Lines 2191-2196 Link Here
2191	# BIT20 - Global Coherency Database changes message.<BR>	2304	# BIT20 - Global Coherency Database changes message.<BR>
2192	# BIT21 - Memory range cachability changes message.<BR>	2305	# BIT21 - Memory range cachability changes message.<BR>
2193	# BIT22 - Detailed debug message.<BR>	2306	# BIT22 - Detailed debug message.<BR>
		2307	# BIT23 - Manageability messages.<BR>
2194	# BIT31 - Error message.<BR>	2308	# BIT31 - Error message.<BR>
2195	# @Prompt Debug Message Print Level.	2309	# @Prompt Debug Message Print Level.
2196	# @Expression 0x80000002 \| (gEfiMdePkgTokenSpaceGuid.PcdDebugPrintErrorLevel & 0x7F84AA00) == 0	2310	# @Expression 0x80000002 \| (gEfiMdePkgTokenSpaceGuid.PcdDebugPrintErrorLevel & 0x7F84AA00) == 0
Lines 2233-2242 Link Here
2233	# @ValidList 0x80000001 \| 8, 16, 32	2347	# @ValidList 0x80000001 \| 8, 16, 32
2234	gEfiMdePkgTokenSpaceGuid.PcdPort80DataWidth\|8\|UINT8\|0x0000002d	2348	gEfiMdePkgTokenSpaceGuid.PcdPort80DataWidth\|8\|UINT8\|0x0000002d
2235		2349
2236	## This value is used to configure X86 Processor FSB clock.
2237	# @Prompt FSB Clock.
2238	gEfiMdePkgTokenSpaceGuid.PcdFSBClock\|200000000\|UINT32\|0x0000000c
2239
2240	## The maximum printable number of characters. UefLib functions: AsciiPrint(), AsciiErrorPrint(),	2350	## The maximum printable number of characters. UefLib functions: AsciiPrint(), AsciiErrorPrint(),
2241	# PrintXY(), AsciiPrintXY(), Print(), ErrorPrint() base on this PCD value to print characters.	2351	# PrintXY(), AsciiPrintXY(), Print(), ErrorPrint() base on this PCD value to print characters.
2242	# @Prompt Maximum Printable Number of Characters.	2352	# @Prompt Maximum Printable Number of Characters.
Lines 2260-2270 Link Here
2260	# @Prompt Memory Address of GuidedExtractHandler Table.	2370	# @Prompt Memory Address of GuidedExtractHandler Table.
2261	gEfiMdePkgTokenSpaceGuid.PcdGuidedExtractHandlerTableAddress\|0x1000000\|UINT64\|0x30001015	2371	gEfiMdePkgTokenSpaceGuid.PcdGuidedExtractHandlerTableAddress\|0x1000000\|UINT64\|0x30001015
2262		2372
		2373	## This value is the IPMI KCS Interface I/O base address used to transmit IPMI commands.
		2374	# The value of 0xca2 is the default I/O base address defined in IPMI specification.
		2375	# @Prompt IPMI KCS Interface I/O Base Address
		2376	gEfiMdePkgTokenSpaceGuid.PcdIpmiKcsIoBaseAddress\|0xca2\|UINT16\|0x00000031
		2377
		2378	## This is SMBus slave address for the SSIF to the BMC.
		2379	# The recommended value defined by IPMI specification is 0x20 (section 12.12).
		2380	# @Prompt IPMI SSIF SMBus slave address
		2381	gEfiMdePkgTokenSpaceGuid.PcdIpmiSsifSmbusSlaveAddr\|0x20\|UINT8\|0x00000032
		2382
		2383	## This is the maximum number of IPMI SSIF request retries.
		2384	# The IPMI specification specified min value is 5 (section 12.17).
		2385	# @Prompt Number of IPMI SSIF request retries.
		2386	gEfiMdePkgTokenSpaceGuid.PcdIpmiSsifRequestRetryCount\|0x05\|UINT8\|0x00000033
		2387
		2388	## This is the required interval for each IPMI request retry.
		2389	# The IPMI specification specified a time range of 60ms to 250ms (section 12.17).
		2390	# The default setting is min.
		2391	# @Prompt Time between IPMI SSIF request retries.
		2392	gEfiMdePkgTokenSpaceGuid.PcdIpmiSsifRequestRetryIntervalMicrosecond\|60000\|UINT32\|0x00000034
		2393
		2394	## This value is the maximum retries of an IPMI SSIF response
		2395	# The default value is the same as the Linux Kernel ipmi_ssif driver.
		2396	# @Prompt Number of IPMI SSIF response retries.
		2397	gEfiMdePkgTokenSpaceGuid.PcdIpmiSsifResponseRetryCount\|250\|UINT8\|0x00000035
		2398
		2399	## This is the required interval for each IPMI response retry.
		2400	# The IPMI specification specified min value is 60ms (section 12.17).
		2401	# @Prompt Time-out for a response, internal
		2402	gEfiMdePkgTokenSpaceGuid.PcdIpmiSsifResponseRetryIntervalMicrosecond\|60000\|UINT32\|0x00000036
		2403
		2404	[PcdsFixedAtBuild.AARCH64, PcdsPatchableInModule.AARCH64]
		2405	## GUID identifying the Rng algorithm implemented by CPU instruction.
		2406	# @Prompt CPU Rng algorithm's GUID.
		2407	gEfiMdePkgTokenSpaceGuid.PcdCpuRngSupportedAlgorithm\|{0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00}\|VOID*\|0x00000037
		2408
		2409	[PcdsFixedAtBuild.RISCV64, PcdsPatchableInModule.RISCV64]
		2410	#
		2411	# Configurability to override RISC-V CPU Features
		2412	# BIT 0 = Cache Management Operations. This bit is relevant only if
		2413	# previous stage has feature enabled and user wants to disable it.
		2414	# BIT 1 = Supervisor Time Compare (Sstc). This bit is relevant only if
		2415	# previous stage has feature enabled and user wants to disable it.
		2416	#
		2417	gEfiMdePkgTokenSpaceGuid.PcdRiscVFeatureOverride\|0xFFFFFFFFFFFFFFFF\|UINT64\|0x69
		2418
2263	[PcdsFixedAtBuild, PcdsPatchableInModule, PcdsDynamic, PcdsDynamicEx]	2419	[PcdsFixedAtBuild, PcdsPatchableInModule, PcdsDynamic, PcdsDynamicEx]
2264	## This value is used to set the base address of PCI express hierarchy.	2420	## This value is used to set the base address of PCI express hierarchy.
2265	# @Prompt PCI Express Base Address.	2421	# @Prompt PCI Express Base Address.
2266	gEfiMdePkgTokenSpaceGuid.PcdPciExpressBaseAddress\|0xE0000000\|UINT64\|0x0000000a	2422	gEfiMdePkgTokenSpaceGuid.PcdPciExpressBaseAddress\|0xE0000000\|UINT64\|0x0000000a
2267		2423
		2424	## This value is used to set the base address of PCI MMIO window that provides I/O access.
		2425	# @Prompt PCI I/O Memory Map Window Base Address.
		2426	gEfiMdePkgTokenSpaceGuid.PcdPciIoTranslation\|0x0\|UINT64\|0x00000040
		2427
		2428	## This value is used for the 32-bit PCI memory map I/O base address translation.
		2429	# @Prompt 32-bit PCI Memory Map I/O Base Address translation.
		2430	gEfiMdePkgTokenSpaceGuid.PcdPciMmio32Translation\|0x0\|UINT64\|0x00000041
		2431
		2432	## This value is used for the 64-bit PCI memory map I/O base address translation.
		2433	# @Prompt 64-bit PCI Memory Map I/O Base Address translation.
		2434	gEfiMdePkgTokenSpaceGuid.PcdPciMmio64Translation\|0x0\|UINT64\|0x00000042
		2435
		2436	## This value is used to set the size of PCI express hierarchy. The default is 256 MB.
		2437	# @Prompt PCI Express Base Size.
		2438	gEfiMdePkgTokenSpaceGuid.PcdPciExpressBaseSize\|0x10000000\|UINT64\|0x0000000f
		2439
2268	## Default current ISO 639-2 language: English & French.	2440	## Default current ISO 639-2 language: English & French.
2269	# @Prompt Default Value of LangCodes Variable.	2441	# @Prompt Default Value of LangCodes Variable.
2270	gEfiMdePkgTokenSpaceGuid.PcdUefiVariableDefaultLangCodes\|"engfraengfra"\|VOID*\|0x0000001c	2442	gEfiMdePkgTokenSpaceGuid.PcdUefiVariableDefaultLangCodes\|"engfraengfra"\|VOID*\|0x0000001c
Lines 2336-2340 Link Here
2336	# @Prompt Boot Timeout (s)	2508	# @Prompt Boot Timeout (s)
2337	gEfiMdePkgTokenSpaceGuid.PcdPlatformBootTimeOut\|0xffff\|UINT16\|0x0000002c	2509	gEfiMdePkgTokenSpaceGuid.PcdPlatformBootTimeOut\|0xffff\|UINT16\|0x0000002c
2338		2510
		2511	## This value is used to configure X86 Processor FSB clock.
		2512	# @Prompt FSB Clock.
		2513	gEfiMdePkgTokenSpaceGuid.PcdFSBClock\|200000000\|UINT32\|0x0000000c
		2514
		2515	## This dynamic PCD indicates the memory encryption attribute of the guest.
		2516	# @Prompt Memory encryption attribute
		2517	gEfiMdePkgTokenSpaceGuid.PcdConfidentialComputingGuestAttr\|0\|UINT64\|0x0000002e
		2518
2339	[UserExtensions.TianoCore."ExtraFiles"]	2519	[UserExtensions.TianoCore."ExtraFiles"]
2340	MdePkgExtra.uni	2520	MdePkgExtra.uni
2341	-

Return to bug 283037

Lines 3-9 set of files from MdePkg is quite large (10MB at the time of writing). To do Link Here

(-)b/sys/contrib/edk2/FREEBSD-upgrade (-5 / +4 lines)
3	this when performing an upgrade, execute the following:	3	this when performing an upgrade, execute the following:
4		4
5	# Generate list of the headers needed to build	5	# Generate list of the headers needed to build
6	cp -r ../vendor/edk2/dist/MdePkg/Include sys/contrib/edk2	6	cp -r ..../MdePkg/Include sys/contrib/edk2
		7	cp ..../MdePkg/MdePkg.dec sys/contrib/edk2/MdePkg.dec
7	cd lib/libefivar	8	cd lib/libefivar
8	make	9	make
9	pushd `make -V .OBJDIR`	10	pushd `make -V .OBJDIR`
Lines 13-21 popd Link Here
13		14
14	# Merge the needed files	15	# Merge the needed files
15	cd ../../sys/contrib/edk2	16	cd ../../sys/contrib/edk2
16	svn revert -R .
17	for i in `cat /tmp/xxx`; do	17	for i in `cat /tmp/xxx`; do
18	svn merge -c VendorRevision svn+ssh://repo.freebsd.org/base/vendor/edk2/dist/MdePkg/$i $i	18	git add $i
19	done	19	done
20	svn merge -c VendorRevision \	20	git clean -df
21	svn+ssh://repo.freebsd.org/base/vendor/edk2/dist/MdePkg/MdePkg.dec MdePkg.dec

Lines 14-22 Link Here

(-)b/sys/contrib/edk2/Include/Guid/WinCertificate.h (-17 / +15 lines)
14	//	14	//
15	// _WIN_CERTIFICATE.wCertificateType	15	// _WIN_CERTIFICATE.wCertificateType
16	//	16	//
17	#define WIN_CERT_TYPE_PKCS_SIGNED_DATA 0x0002	17	#define WIN_CERT_TYPE_PKCS_SIGNED_DATA 0x0002
18	#define WIN_CERT_TYPE_EFI_PKCS115 0x0EF0	18	#define WIN_CERT_TYPE_EFI_PKCS115 0x0EF0
19	#define WIN_CERT_TYPE_EFI_GUID 0x0EF1	19	#define WIN_CERT_TYPE_EFI_GUID 0x0EF1
20		20
21	///	21	///
22	/// The WIN_CERTIFICATE structure is part of the PE/COFF specification.	22	/// The WIN_CERTIFICATE structure is part of the PE/COFF specification.
Lines 26-43 typedef struct { Link Here
26	/// The length of the entire certificate,	26	/// The length of the entire certificate,
27	/// including the length of the header, in bytes.	27	/// including the length of the header, in bytes.
28	///	28	///
29	UINT32 dwLength;	29	UINT32 dwLength;
30	///	30	///
31	/// The revision level of the WIN_CERTIFICATE	31	/// The revision level of the WIN_CERTIFICATE
32	/// structure. The current revision level is 0x0200.	32	/// structure. The current revision level is 0x0200.
33	///	33	///
34	UINT16 wRevision;	34	UINT16 wRevision;
35	///	35	///
36	/// The certificate type. See WIN_CERT_TYPE_xxx for the UEFI	36	/// The certificate type. See WIN_CERT_TYPE_xxx for the UEFI
37	/// certificate types. The UEFI specification reserves the range of	37	/// certificate types. The UEFI specification reserves the range of
38	/// certificate type values from 0x0EF0 to 0x0EFF.	38	/// certificate type values from 0x0EF0 to 0x0EFF.
39	///	39	///
40	UINT16 wCertificateType;	40	UINT16 wCertificateType;
41	///	41	///
42	/// The following is the actual certificate. The format of	42	/// The following is the actual certificate. The format of
43	/// the certificate depends on wCertificateType.	43	/// the certificate depends on wCertificateType.
Lines 56-67 typedef struct { Link Here
56	/// WIN_CERTIFICATE_UEFI_GUID.CertData	56	/// WIN_CERTIFICATE_UEFI_GUID.CertData
57	///	57	///
58	typedef struct {	58	typedef struct {
59	EFI_GUID HashType;	59	EFI_GUID HashType;
60	UINT8 PublicKey[256];	60	UINT8 PublicKey[256];
61	UINT8 Signature[256];	61	UINT8 Signature[256];
62	} EFI_CERT_BLOCK_RSA_2048_SHA256;	62	} EFI_CERT_BLOCK_RSA_2048_SHA256;
63		63
64
65	///	64	///
66	/// Certificate which encapsulates a GUID-specific digital signature	65	/// Certificate which encapsulates a GUID-specific digital signature
67	///	66	///
Lines 70-91 typedef struct { Link Here
70	/// This is the standard WIN_CERTIFICATE header, where	69	/// This is the standard WIN_CERTIFICATE header, where
71	/// wCertificateType is set to WIN_CERT_TYPE_EFI_GUID.	70	/// wCertificateType is set to WIN_CERT_TYPE_EFI_GUID.
72	///	71	///
73	WIN_CERTIFICATE Hdr;	72	WIN_CERTIFICATE Hdr;
74	///	73	///
75	/// This is the unique id which determines the	74	/// This is the unique id which determines the
76	/// format of the CertData. .	75	/// format of the CertData. .
77	///	76	///
78	EFI_GUID CertType;	77	EFI_GUID CertType;
79	///	78	///
80	/// The following is the certificate data. The format of	79	/// The following is the certificate data. The format of
81	/// the data is determined by the CertType.	80	/// the data is determined by the CertType.
82	/// If CertType is EFI_CERT_TYPE_RSA2048_SHA256_GUID,	81	/// If CertType is EFI_CERT_TYPE_RSA2048_SHA256_GUID,
83	/// the CertData will be EFI_CERT_BLOCK_RSA_2048_SHA256 structure.	82	/// the CertData will be EFI_CERT_BLOCK_RSA_2048_SHA256 structure.
84	///	83	///
85	UINT8 CertData[1];	84	UINT8 CertData[1];
86	} WIN_CERTIFICATE_UEFI_GUID;	85	} WIN_CERTIFICATE_UEFI_GUID;
87		86
88
89	///	87	///
90	/// Certificate which encapsulates the RSASSA_PKCS1-v1_5 digital signature.	88	/// Certificate which encapsulates the RSASSA_PKCS1-v1_5 digital signature.
91	///	89	///
Lines 99-110 typedef struct { Link Here
99	/// This is the standard WIN_CERTIFICATE header, where	97	/// This is the standard WIN_CERTIFICATE header, where
100	/// wCertificateType is set to WIN_CERT_TYPE_UEFI_PKCS1_15.	98	/// wCertificateType is set to WIN_CERT_TYPE_UEFI_PKCS1_15.
101	///	99	///
102	WIN_CERTIFICATE Hdr;	100	WIN_CERTIFICATE Hdr;
103	///	101	///
104	/// This is the hashing algorithm which was performed on the	102	/// This is the hashing algorithm which was performed on the
105	/// UEFI executable when creating the digital signature.	103	/// UEFI executable when creating the digital signature.
106	///	104	///
107	EFI_GUID HashAlgorithm;	105	EFI_GUID HashAlgorithm;
108	///	106	///
109	/// The following is the actual digital signature. The	107	/// The following is the actual digital signature. The
110	/// size of the signature is the same size as the key	108	/// size of the signature is the same size as the key
Lines 117-122 typedef struct { Link Here
117	///	115	///
118	} WIN_CERTIFICATE_EFI_PKCS1_15;	116	} WIN_CERTIFICATE_EFI_PKCS1_15;
119		117
120	extern EFI_GUID gEfiCertTypeRsa2048Sha256Guid;	118	extern EFI_GUID gEfiCertTypeRsa2048Sha256Guid;
121		119
122	#endif	120	#endif

Lines 13-21 Link Here

(-)b/sys/contrib/edk2/Include/IndustryStandard/Acpi20.h (-174 / +174 lines)
13	//	13	//
14	// Define for Descriptor	14	// Define for Descriptor
15	//	15	//
16	#define ACPI_LARGE_GENERIC_REGISTER_DESCRIPTOR_NAME 0x02	16	#define ACPI_LARGE_GENERIC_REGISTER_DESCRIPTOR_NAME 0x02
17		17
18	#define ACPI_GENERIC_REGISTER_DESCRIPTOR 0x82	18	#define ACPI_GENERIC_REGISTER_DESCRIPTOR 0x82
19		19
20	//	20	//
21	// Ensure proper structure formats	21	// Ensure proper structure formats
Lines 45-55 typedef PACKED struct { Link Here
45	/// ACPI 2.0 Generic Address Space definition	45	/// ACPI 2.0 Generic Address Space definition
46	///	46	///
47	typedef struct {	47	typedef struct {
48	UINT8 AddressSpaceId;	48	UINT8 AddressSpaceId;
49	UINT8 RegisterBitWidth;	49	UINT8 RegisterBitWidth;
50	UINT8 RegisterBitOffset;	50	UINT8 RegisterBitOffset;
51	UINT8 Reserved;	51	UINT8 Reserved;
52	UINT64 Address;	52	UINT64 Address;
53	} EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE;	53	} EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE;
54		54
55	//	55	//
Lines 70-98 typedef struct { Link Here
70	/// Root System Description Pointer Structure	70	/// Root System Description Pointer Structure
71	///	71	///
72	typedef struct {	72	typedef struct {
73	UINT64 Signature;	73	UINT64 Signature;
74	UINT8 Checksum;	74	UINT8 Checksum;
75	UINT8 OemId[6];	75	UINT8 OemId[6];
76	UINT8 Revision;	76	UINT8 Revision;
77	UINT32 RsdtAddress;	77	UINT32 RsdtAddress;
78	UINT32 Length;	78	UINT32 Length;
79	UINT64 XsdtAddress;	79	UINT64 XsdtAddress;
80	UINT8 ExtendedChecksum;	80	UINT8 ExtendedChecksum;
81	UINT8 Reserved[3];	81	UINT8 Reserved[3];
82	} EFI_ACPI_2_0_ROOT_SYSTEM_DESCRIPTION_POINTER;	82	} EFI_ACPI_2_0_ROOT_SYSTEM_DESCRIPTION_POINTER;
83		83
84	///	84	///
85	/// RSD_PTR Revision (as defined in ACPI 2.0 spec.)	85	/// RSD_PTR Revision (as defined in ACPI 2.0 spec.)
86	///	86	///
87	#define EFI_ACPI_2_0_ROOT_SYSTEM_DESCRIPTION_POINTER_REVISION 0x02	87	#define EFI_ACPI_2_0_ROOT_SYSTEM_DESCRIPTION_POINTER_REVISION 0x02
88		88
89	///	89	///
90	/// Common table header, this prefaces all ACPI tables, including FACS, but	90	/// Common table header, this prefaces all ACPI tables, including FACS, but
91	/// excluding the RSD PTR structure	91	/// excluding the RSD PTR structure
92	///	92	///
93	typedef struct {	93	typedef struct {
94	UINT32 Signature;	94	UINT32 Signature;
95	UINT32 Length;	95	UINT32 Length;
96	} EFI_ACPI_2_0_COMMON_HEADER;	96	} EFI_ACPI_2_0_COMMON_HEADER;
97		97
98	//	98	//
Lines 104-110 typedef struct { Link Here
104	///	104	///
105	/// RSDT Revision (as defined in ACPI 2.0 spec.)	105	/// RSDT Revision (as defined in ACPI 2.0 spec.)
106	///	106	///
107	#define EFI_ACPI_2_0_ROOT_SYSTEM_DESCRIPTION_TABLE_REVISION 0x01	107	#define EFI_ACPI_2_0_ROOT_SYSTEM_DESCRIPTION_TABLE_REVISION 0x01
108		108
109	//	109	//
110	// Extended System Description Table	110	// Extended System Description Table
Lines 115-178 typedef struct { Link Here
115	///	115	///
116	/// XSDT Revision (as defined in ACPI 2.0 spec.)	116	/// XSDT Revision (as defined in ACPI 2.0 spec.)
117	///	117	///
118	#define EFI_ACPI_2_0_EXTENDED_SYSTEM_DESCRIPTION_TABLE_REVISION 0x01	118	#define EFI_ACPI_2_0_EXTENDED_SYSTEM_DESCRIPTION_TABLE_REVISION 0x01
119		119
120	///	120	///
121	/// Fixed ACPI Description Table Structure (FADT)	121	/// Fixed ACPI Description Table Structure (FADT)
122	///	122	///
123	typedef struct {	123	typedef struct {
124	EFI_ACPI_DESCRIPTION_HEADER Header;	124	EFI_ACPI_DESCRIPTION_HEADER Header;
125	UINT32 FirmwareCtrl;	125	UINT32 FirmwareCtrl;
126	UINT32 Dsdt;	126	UINT32 Dsdt;
127	UINT8 Reserved0;	127	UINT8 Reserved0;
128	UINT8 PreferredPmProfile;	128	UINT8 PreferredPmProfile;
129	UINT16 SciInt;	129	UINT16 SciInt;
130	UINT32 SmiCmd;	130	UINT32 SmiCmd;
131	UINT8 AcpiEnable;	131	UINT8 AcpiEnable;
132	UINT8 AcpiDisable;	132	UINT8 AcpiDisable;
133	UINT8 S4BiosReq;	133	UINT8 S4BiosReq;
134	UINT8 PstateCnt;	134	UINT8 PstateCnt;
135	UINT32 Pm1aEvtBlk;	135	UINT32 Pm1aEvtBlk;
136	UINT32 Pm1bEvtBlk;	136	UINT32 Pm1bEvtBlk;
137	UINT32 Pm1aCntBlk;	137	UINT32 Pm1aCntBlk;
138	UINT32 Pm1bCntBlk;	138	UINT32 Pm1bCntBlk;
139	UINT32 Pm2CntBlk;	139	UINT32 Pm2CntBlk;
140	UINT32 PmTmrBlk;	140	UINT32 PmTmrBlk;
141	UINT32 Gpe0Blk;	141	UINT32 Gpe0Blk;
142	UINT32 Gpe1Blk;	142	UINT32 Gpe1Blk;
143	UINT8 Pm1EvtLen;	143	UINT8 Pm1EvtLen;
144	UINT8 Pm1CntLen;	144	UINT8 Pm1CntLen;
145	UINT8 Pm2CntLen;	145	UINT8 Pm2CntLen;
146	UINT8 PmTmrLen;	146	UINT8 PmTmrLen;
147	UINT8 Gpe0BlkLen;	147	UINT8 Gpe0BlkLen;
148	UINT8 Gpe1BlkLen;	148	UINT8 Gpe1BlkLen;
149	UINT8 Gpe1Base;	149	UINT8 Gpe1Base;
150	UINT8 CstCnt;	150	UINT8 CstCnt;
151	UINT16 PLvl2Lat;	151	UINT16 PLvl2Lat;
152	UINT16 PLvl3Lat;	152	UINT16 PLvl3Lat;
153	UINT16 FlushSize;	153	UINT16 FlushSize;
154	UINT16 FlushStride;	154	UINT16 FlushStride;
155	UINT8 DutyOffset;	155	UINT8 DutyOffset;
156	UINT8 DutyWidth;	156	UINT8 DutyWidth;
157	UINT8 DayAlrm;	157	UINT8 DayAlrm;
158	UINT8 MonAlrm;	158	UINT8 MonAlrm;
159	UINT8 Century;	159	UINT8 Century;
160	UINT16 IaPcBootArch;	160	UINT16 IaPcBootArch;
161	UINT8 Reserved1;	161	UINT8 Reserved1;
162	UINT32 Flags;	162	UINT32 Flags;
163	EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE ResetReg;	163	EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE ResetReg;
164	UINT8 ResetValue;	164	UINT8 ResetValue;
165	UINT8 Reserved2[3];	165	UINT8 Reserved2[3];
166	UINT64 XFirmwareCtrl;	166	UINT64 XFirmwareCtrl;
167	UINT64 XDsdt;	167	UINT64 XDsdt;
168	EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE XPm1aEvtBlk;	168	EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE XPm1aEvtBlk;
169	EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE XPm1bEvtBlk;	169	EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE XPm1bEvtBlk;
170	EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE XPm1aCntBlk;	170	EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE XPm1aCntBlk;
171	EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE XPm1bCntBlk;	171	EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE XPm1bCntBlk;
172	EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE XPm2CntBlk;	172	EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE XPm2CntBlk;
173	EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE XPmTmrBlk;	173	EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE XPmTmrBlk;
174	EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE XGpe0Blk;	174	EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE XGpe0Blk;
175	EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE XGpe1Blk;	175	EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE XGpe1Blk;
176	} EFI_ACPI_2_0_FIXED_ACPI_DESCRIPTION_TABLE;	176	} EFI_ACPI_2_0_FIXED_ACPI_DESCRIPTION_TABLE;
177		177
178	///	178	///
Lines 183-235 typedef struct { Link Here
183	//	183	//
184	// Fixed ACPI Description Table Preferred Power Management Profile	184	// Fixed ACPI Description Table Preferred Power Management Profile
185	//	185	//
186	#define EFI_ACPI_2_0_PM_PROFILE_UNSPECIFIED 0	186	#define EFI_ACPI_2_0_PM_PROFILE_UNSPECIFIED 0
187	#define EFI_ACPI_2_0_PM_PROFILE_DESKTOP 1	187	#define EFI_ACPI_2_0_PM_PROFILE_DESKTOP 1
188	#define EFI_ACPI_2_0_PM_PROFILE_MOBILE 2	188	#define EFI_ACPI_2_0_PM_PROFILE_MOBILE 2
189	#define EFI_ACPI_2_0_PM_PROFILE_WORKSTATION 3	189	#define EFI_ACPI_2_0_PM_PROFILE_WORKSTATION 3
190	#define EFI_ACPI_2_0_PM_PROFILE_ENTERPRISE_SERVER 4	190	#define EFI_ACPI_2_0_PM_PROFILE_ENTERPRISE_SERVER 4
191	#define EFI_ACPI_2_0_PM_PROFILE_SOHO_SERVER 5	191	#define EFI_ACPI_2_0_PM_PROFILE_SOHO_SERVER 5
192	#define EFI_ACPI_2_0_PM_PROFILE_APPLIANCE_PC 6	192	#define EFI_ACPI_2_0_PM_PROFILE_APPLIANCE_PC 6
193		193
194	//	194	//
195	// Fixed ACPI Description Table Boot Architecture Flags	195	// Fixed ACPI Description Table Boot Architecture Flags
196	// All other bits are reserved and must be set to 0.	196	// All other bits are reserved and must be set to 0.
197	//	197	//
198	#define EFI_ACPI_2_0_LEGACY_DEVICES BIT0	198	#define EFI_ACPI_2_0_LEGACY_DEVICES BIT0
199	#define EFI_ACPI_2_0_8042 BIT1	199	#define EFI_ACPI_2_0_8042 BIT1
200		200
201	//	201	//
202	// Fixed ACPI Description Table Fixed Feature Flags	202	// Fixed ACPI Description Table Fixed Feature Flags
203	// All other bits are reserved and must be set to 0.	203	// All other bits are reserved and must be set to 0.
204	//	204	//
205	#define EFI_ACPI_2_0_WBINVD BIT0	205	#define EFI_ACPI_2_0_WBINVD BIT0
206	#define EFI_ACPI_2_0_WBINVD_FLUSH BIT1	206	#define EFI_ACPI_2_0_WBINVD_FLUSH BIT1
207	#define EFI_ACPI_2_0_PROC_C1 BIT2	207	#define EFI_ACPI_2_0_PROC_C1 BIT2
208	#define EFI_ACPI_2_0_P_LVL2_UP BIT3	208	#define EFI_ACPI_2_0_P_LVL2_UP BIT3
209	#define EFI_ACPI_2_0_PWR_BUTTON BIT4	209	#define EFI_ACPI_2_0_PWR_BUTTON BIT4
210	#define EFI_ACPI_2_0_SLP_BUTTON BIT5	210	#define EFI_ACPI_2_0_SLP_BUTTON BIT5
211	#define EFI_ACPI_2_0_FIX_RTC BIT6	211	#define EFI_ACPI_2_0_FIX_RTC BIT6
212	#define EFI_ACPI_2_0_RTC_S4 BIT7	212	#define EFI_ACPI_2_0_RTC_S4 BIT7
213	#define EFI_ACPI_2_0_TMR_VAL_EXT BIT8	213	#define EFI_ACPI_2_0_TMR_VAL_EXT BIT8
214	#define EFI_ACPI_2_0_DCK_CAP BIT9	214	#define EFI_ACPI_2_0_DCK_CAP BIT9
215	#define EFI_ACPI_2_0_RESET_REG_SUP BIT10	215	#define EFI_ACPI_2_0_RESET_REG_SUP BIT10
216	#define EFI_ACPI_2_0_SEALED_CASE BIT11	216	#define EFI_ACPI_2_0_SEALED_CASE BIT11
217	#define EFI_ACPI_2_0_HEADLESS BIT12	217	#define EFI_ACPI_2_0_HEADLESS BIT12
218	#define EFI_ACPI_2_0_CPU_SW_SLP BIT13	218	#define EFI_ACPI_2_0_CPU_SW_SLP BIT13
219		219
220	///	220	///
221	/// Firmware ACPI Control Structure	221	/// Firmware ACPI Control Structure
222	///	222	///
223	typedef struct {	223	typedef struct {
224	UINT32 Signature;	224	UINT32 Signature;
225	UINT32 Length;	225	UINT32 Length;
226	UINT32 HardwareSignature;	226	UINT32 HardwareSignature;
227	UINT32 FirmwareWakingVector;	227	UINT32 FirmwareWakingVector;
228	UINT32 GlobalLock;	228	UINT32 GlobalLock;
229	UINT32 Flags;	229	UINT32 Flags;
230	UINT64 XFirmwareWakingVector;	230	UINT64 XFirmwareWakingVector;
231	UINT8 Version;	231	UINT8 Version;
232	UINT8 Reserved[31];	232	UINT8 Reserved[31];
233	} EFI_ACPI_2_0_FIRMWARE_ACPI_CONTROL_STRUCTURE;	233	} EFI_ACPI_2_0_FIRMWARE_ACPI_CONTROL_STRUCTURE;
234		234
235	///	235	///
Lines 241-268 typedef struct { Link Here
241	/// Firmware Control Structure Feature Flags	241	/// Firmware Control Structure Feature Flags
242	/// All other bits are reserved and must be set to 0.	242	/// All other bits are reserved and must be set to 0.
243	///	243	///
244	#define EFI_ACPI_2_0_S4BIOS_F BIT0	244	#define EFI_ACPI_2_0_S4BIOS_F BIT0
245		245
246	///	246	///
247	/// Multiple APIC Description Table header definition. The rest of the table	247	/// Multiple APIC Description Table header definition. The rest of the table
248	/// must be defined in a platform specific manner.	248	/// must be defined in a platform specific manner.
249	///	249	///
250	typedef struct {	250	typedef struct {
251	EFI_ACPI_DESCRIPTION_HEADER Header;	251	EFI_ACPI_DESCRIPTION_HEADER Header;
252	UINT32 LocalApicAddress;	252	UINT32 LocalApicAddress;
253	UINT32 Flags;	253	UINT32 Flags;
254	} EFI_ACPI_2_0_MULTIPLE_APIC_DESCRIPTION_TABLE_HEADER;	254	} EFI_ACPI_2_0_MULTIPLE_APIC_DESCRIPTION_TABLE_HEADER;
255		255
256	///	256	///
257	/// MADT Revision (as defined in ACPI 2.0 spec.)	257	/// MADT Revision (as defined in ACPI 2.0 spec.)
258	///	258	///
259	#define EFI_ACPI_2_0_MULTIPLE_APIC_DESCRIPTION_TABLE_REVISION 0x01	259	#define EFI_ACPI_2_0_MULTIPLE_APIC_DESCRIPTION_TABLE_REVISION 0x01
260		260
261	///	261	///
262	/// Multiple APIC Flags	262	/// Multiple APIC Flags
263	/// All other bits are reserved and must be set to 0.	263	/// All other bits are reserved and must be set to 0.
264	///	264	///
265	#define EFI_ACPI_2_0_PCAT_COMPAT BIT0	265	#define EFI_ACPI_2_0_PCAT_COMPAT BIT0
266		266
267	//	267	//
268	// Multiple APIC Description Table APIC structure types	268	// Multiple APIC Description Table APIC structure types
Lines 287-413 typedef struct { Link Here
287	/// Processor Local APIC Structure Definition	287	/// Processor Local APIC Structure Definition
288	///	288	///
289	typedef struct {	289	typedef struct {
290	UINT8 Type;	290	UINT8 Type;
291	UINT8 Length;	291	UINT8 Length;
292	UINT8 AcpiProcessorId;	292	UINT8 AcpiProcessorId;
293	UINT8 ApicId;	293	UINT8 ApicId;
294	UINT32 Flags;	294	UINT32 Flags;
295	} EFI_ACPI_2_0_PROCESSOR_LOCAL_APIC_STRUCTURE;	295	} EFI_ACPI_2_0_PROCESSOR_LOCAL_APIC_STRUCTURE;
296		296
297	///	297	///
298	/// Local APIC Flags. All other bits are reserved and must be 0.	298	/// Local APIC Flags. All other bits are reserved and must be 0.
299	///	299	///
300	#define EFI_ACPI_2_0_LOCAL_APIC_ENABLED BIT0	300	#define EFI_ACPI_2_0_LOCAL_APIC_ENABLED BIT0
301		301
302	///	302	///
303	/// IO APIC Structure	303	/// IO APIC Structure
304	///	304	///
305	typedef struct {	305	typedef struct {
306	UINT8 Type;	306	UINT8 Type;
307	UINT8 Length;	307	UINT8 Length;
308	UINT8 IoApicId;	308	UINT8 IoApicId;
309	UINT8 Reserved;	309	UINT8 Reserved;
310	UINT32 IoApicAddress;	310	UINT32 IoApicAddress;
311	UINT32 GlobalSystemInterruptBase;	311	UINT32 GlobalSystemInterruptBase;
312	} EFI_ACPI_2_0_IO_APIC_STRUCTURE;	312	} EFI_ACPI_2_0_IO_APIC_STRUCTURE;
313		313
314	///	314	///
315	/// Interrupt Source Override Structure	315	/// Interrupt Source Override Structure
316	///	316	///
317	typedef struct {	317	typedef struct {
318	UINT8 Type;	318	UINT8 Type;
319	UINT8 Length;	319	UINT8 Length;
320	UINT8 Bus;	320	UINT8 Bus;
321	UINT8 Source;	321	UINT8 Source;
322	UINT32 GlobalSystemInterrupt;	322	UINT32 GlobalSystemInterrupt;
323	UINT16 Flags;	323	UINT16 Flags;
324	} EFI_ACPI_2_0_INTERRUPT_SOURCE_OVERRIDE_STRUCTURE;	324	} EFI_ACPI_2_0_INTERRUPT_SOURCE_OVERRIDE_STRUCTURE;
325		325
326	///	326	///
327	/// Non-Maskable Interrupt Source Structure	327	/// Non-Maskable Interrupt Source Structure
328	///	328	///
329	typedef struct {	329	typedef struct {
330	UINT8 Type;	330	UINT8 Type;
331	UINT8 Length;	331	UINT8 Length;
332	UINT16 Flags;	332	UINT16 Flags;
333	UINT32 GlobalSystemInterrupt;	333	UINT32 GlobalSystemInterrupt;
334	} EFI_ACPI_2_0_NON_MASKABLE_INTERRUPT_SOURCE_STRUCTURE;	334	} EFI_ACPI_2_0_NON_MASKABLE_INTERRUPT_SOURCE_STRUCTURE;
335		335
336	///	336	///
337	/// Local APIC NMI Structure	337	/// Local APIC NMI Structure
338	///	338	///
339	typedef struct {	339	typedef struct {
340	UINT8 Type;	340	UINT8 Type;
341	UINT8 Length;	341	UINT8 Length;
342	UINT8 AcpiProcessorId;	342	UINT8 AcpiProcessorId;
343	UINT16 Flags;	343	UINT16 Flags;
344	UINT8 LocalApicLint;	344	UINT8 LocalApicLint;
345	} EFI_ACPI_2_0_LOCAL_APIC_NMI_STRUCTURE;	345	} EFI_ACPI_2_0_LOCAL_APIC_NMI_STRUCTURE;
346		346
347	///	347	///
348	/// Local APIC Address Override Structure	348	/// Local APIC Address Override Structure
349	///	349	///
350	typedef struct {	350	typedef struct {
351	UINT8 Type;	351	UINT8 Type;
352	UINT8 Length;	352	UINT8 Length;
353	UINT16 Reserved;	353	UINT16 Reserved;
354	UINT64 LocalApicAddress;	354	UINT64 LocalApicAddress;
355	} EFI_ACPI_2_0_LOCAL_APIC_ADDRESS_OVERRIDE_STRUCTURE;	355	} EFI_ACPI_2_0_LOCAL_APIC_ADDRESS_OVERRIDE_STRUCTURE;
356		356
357	///	357	///
358	/// IO SAPIC Structure	358	/// IO SAPIC Structure
359	///	359	///
360	typedef struct {	360	typedef struct {
361	UINT8 Type;	361	UINT8 Type;
362	UINT8 Length;	362	UINT8 Length;
363	UINT8 IoApicId;	363	UINT8 IoApicId;
364	UINT8 Reserved;	364	UINT8 Reserved;
365	UINT32 GlobalSystemInterruptBase;	365	UINT32 GlobalSystemInterruptBase;
366	UINT64 IoSapicAddress;	366	UINT64 IoSapicAddress;
367	} EFI_ACPI_2_0_IO_SAPIC_STRUCTURE;	367	} EFI_ACPI_2_0_IO_SAPIC_STRUCTURE;
368		368
369	///	369	///
370	/// Local SAPIC Structure	370	/// Local SAPIC Structure
371	///	371	///
372	typedef struct {	372	typedef struct {
373	UINT8 Type;	373	UINT8 Type;
374	UINT8 Length;	374	UINT8 Length;
375	UINT8 AcpiProcessorId;	375	UINT8 AcpiProcessorId;
376	UINT8 LocalSapicId;	376	UINT8 LocalSapicId;
377	UINT8 LocalSapicEid;	377	UINT8 LocalSapicEid;
378	UINT8 Reserved[3];	378	UINT8 Reserved[3];
379	UINT32 Flags;	379	UINT32 Flags;
380	} EFI_ACPI_2_0_PROCESSOR_LOCAL_SAPIC_STRUCTURE;	380	} EFI_ACPI_2_0_PROCESSOR_LOCAL_SAPIC_STRUCTURE;
381		381
382	///	382	///
383	/// Platform Interrupt Sources Structure	383	/// Platform Interrupt Sources Structure
384	///	384	///
385	typedef struct {	385	typedef struct {
386	UINT8 Type;	386	UINT8 Type;
387	UINT8 Length;	387	UINT8 Length;
388	UINT16 Flags;	388	UINT16 Flags;
389	UINT8 InterruptType;	389	UINT8 InterruptType;
390	UINT8 ProcessorId;	390	UINT8 ProcessorId;
391	UINT8 ProcessorEid;	391	UINT8 ProcessorEid;
392	UINT8 IoSapicVector;	392	UINT8 IoSapicVector;
393	UINT32 GlobalSystemInterrupt;	393	UINT32 GlobalSystemInterrupt;
394	UINT32 Reserved;	394	UINT32 Reserved;
395	} EFI_ACPI_2_0_PLATFORM_INTERRUPT_SOURCES_STRUCTURE;	395	} EFI_ACPI_2_0_PLATFORM_INTERRUPT_SOURCES_STRUCTURE;
396		396
397	///	397	///
398	/// Smart Battery Description Table (SBST)	398	/// Smart Battery Description Table (SBST)
399	///	399	///
400	typedef struct {	400	typedef struct {
401	EFI_ACPI_DESCRIPTION_HEADER Header;	401	EFI_ACPI_DESCRIPTION_HEADER Header;
402	UINT32 WarningEnergyLevel;	402	UINT32 WarningEnergyLevel;
403	UINT32 LowEnergyLevel;	403	UINT32 LowEnergyLevel;
404	UINT32 CriticalEnergyLevel;	404	UINT32 CriticalEnergyLevel;
405	} EFI_ACPI_2_0_SMART_BATTERY_DESCRIPTION_TABLE;	405	} EFI_ACPI_2_0_SMART_BATTERY_DESCRIPTION_TABLE;
406		406
407	///	407	///
408	/// SBST Version (as defined in ACPI 2.0 spec.)	408	/// SBST Version (as defined in ACPI 2.0 spec.)
409	///	409	///
410	#define EFI_ACPI_2_0_SMART_BATTERY_DESCRIPTION_TABLE_REVISION 0x01	410	#define EFI_ACPI_2_0_SMART_BATTERY_DESCRIPTION_TABLE_REVISION 0x01
411		411
412	///	412	///
413	/// Embedded Controller Boot Resources Table (ECDT)	413	/// Embedded Controller Boot Resources Table (ECDT)
Lines 415-425 typedef struct { Link Here
415	/// a fully qualified reference to the name space object.	415	/// a fully qualified reference to the name space object.
416	///	416	///
417	typedef struct {	417	typedef struct {
418	EFI_ACPI_DESCRIPTION_HEADER Header;	418	EFI_ACPI_DESCRIPTION_HEADER Header;
419	EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE EcControl;	419	EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE EcControl;
420	EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE EcData;	420	EFI_ACPI_2_0_GENERIC_ADDRESS_STRUCTURE EcData;
421	UINT32 Uid;	421	UINT32 Uid;
422	UINT8 GpeBit;	422	UINT8 GpeBit;
423	} EFI_ACPI_2_0_EMBEDDED_CONTROLLER_BOOT_RESOURCES_TABLE;	423	} EFI_ACPI_2_0_EMBEDDED_CONTROLLER_BOOT_RESOURCES_TABLE;
424		424
425	///	425	///

Lines 2-8 Link Here

(-)b/sys/contrib/edk2/Include/IndustryStandard/AcpiAml.h (-150 / +155 lines)
2	This file contains AML code definition in the latest ACPI spec.	2	This file contains AML code definition in the latest ACPI spec.
3		3
4	Copyright (c) 2011, Intel Corporation. All rights reserved.<BR>	4	Copyright (c) 2011, Intel Corporation. All rights reserved.<BR>
5	Copyright (c) 2019, ARM Limited. All rights reserved.<BR>	5	Copyright (c) 2019 - 2021, Arm Limited. All rights reserved.<BR>
6	SPDX-License-Identifier: BSD-2-Clause-Patent	6	SPDX-License-Identifier: BSD-2-Clause-Patent
7		7
8	**/	8	**/
Lines 17-179 Link Here
17	//	17	//
18	// Primary OpCode	18	// Primary OpCode
19	//	19	//
20	#define AML_ZERO_OP 0x00	20	#define AML_ZERO_OP 0x00
21	#define AML_ONE_OP 0x01	21	#define AML_ONE_OP 0x01
22	#define AML_ALIAS_OP 0x06	22	#define AML_ALIAS_OP 0x06
23	#define AML_NAME_OP 0x08	23	#define AML_NAME_OP 0x08
24	#define AML_BYTE_PREFIX 0x0a	24	#define AML_BYTE_PREFIX 0x0a
25	#define AML_WORD_PREFIX 0x0b	25	#define AML_WORD_PREFIX 0x0b
26	#define AML_DWORD_PREFIX 0x0c	26	#define AML_DWORD_PREFIX 0x0c
27	#define AML_STRING_PREFIX 0x0d	27	#define AML_STRING_PREFIX 0x0d
28	#define AML_QWORD_PREFIX 0x0e	28	#define AML_QWORD_PREFIX 0x0e
29	#define AML_SCOPE_OP 0x10	29	#define AML_SCOPE_OP 0x10
30	#define AML_BUFFER_OP 0x11	30	#define AML_BUFFER_OP 0x11
31	#define AML_PACKAGE_OP 0x12	31	#define AML_PACKAGE_OP 0x12
32	#define AML_VAR_PACKAGE_OP 0x13	32	#define AML_VAR_PACKAGE_OP 0x13
33	#define AML_METHOD_OP 0x14	33	#define AML_METHOD_OP 0x14
34	#define AML_EXTERNAL_OP 0x15	34	#define AML_EXTERNAL_OP 0x15
35	#define AML_DUAL_NAME_PREFIX 0x2e	35	#define AML_DUAL_NAME_PREFIX 0x2e
36	#define AML_MULTI_NAME_PREFIX 0x2f	36	#define AML_MULTI_NAME_PREFIX 0x2f
37	#define AML_NAME_CHAR_A 0x41	37	#define AML_NAME_CHAR_A 0x41
38	#define AML_NAME_CHAR_B 0x42	38	#define AML_NAME_CHAR_B 0x42
39	#define AML_NAME_CHAR_C 0x43	39	#define AML_NAME_CHAR_C 0x43
40	#define AML_NAME_CHAR_D 0x44	40	#define AML_NAME_CHAR_D 0x44
41	#define AML_NAME_CHAR_E 0x45	41	#define AML_NAME_CHAR_E 0x45
42	#define AML_NAME_CHAR_F 0x46	42	#define AML_NAME_CHAR_F 0x46
43	#define AML_NAME_CHAR_G 0x47	43	#define AML_NAME_CHAR_G 0x47
44	#define AML_NAME_CHAR_H 0x48	44	#define AML_NAME_CHAR_H 0x48
45	#define AML_NAME_CHAR_I 0x49	45	#define AML_NAME_CHAR_I 0x49
46	#define AML_NAME_CHAR_J 0x4a	46	#define AML_NAME_CHAR_J 0x4a
47	#define AML_NAME_CHAR_K 0x4b	47	#define AML_NAME_CHAR_K 0x4b
48	#define AML_NAME_CHAR_L 0x4c	48	#define AML_NAME_CHAR_L 0x4c
49	#define AML_NAME_CHAR_M 0x4d	49	#define AML_NAME_CHAR_M 0x4d
50	#define AML_NAME_CHAR_N 0x4e	50	#define AML_NAME_CHAR_N 0x4e
51	#define AML_NAME_CHAR_O 0x4f	51	#define AML_NAME_CHAR_O 0x4f
52	#define AML_NAME_CHAR_P 0x50	52	#define AML_NAME_CHAR_P 0x50
53	#define AML_NAME_CHAR_Q 0x51	53	#define AML_NAME_CHAR_Q 0x51
54	#define AML_NAME_CHAR_R 0x52	54	#define AML_NAME_CHAR_R 0x52
55	#define AML_NAME_CHAR_S 0x53	55	#define AML_NAME_CHAR_S 0x53
56	#define AML_NAME_CHAR_T 0x54	56	#define AML_NAME_CHAR_T 0x54
57	#define AML_NAME_CHAR_U 0x55	57	#define AML_NAME_CHAR_U 0x55
58	#define AML_NAME_CHAR_V 0x56	58	#define AML_NAME_CHAR_V 0x56
59	#define AML_NAME_CHAR_W 0x57	59	#define AML_NAME_CHAR_W 0x57
60	#define AML_NAME_CHAR_X 0x58	60	#define AML_NAME_CHAR_X 0x58
61	#define AML_NAME_CHAR_Y 0x59	61	#define AML_NAME_CHAR_Y 0x59
62	#define AML_NAME_CHAR_Z 0x5a	62	#define AML_NAME_CHAR_Z 0x5a
63	#define AML_ROOT_CHAR 0x5c	63	#define AML_ROOT_CHAR 0x5c
64	#define AML_PARENT_PREFIX_CHAR 0x5e	64	#define AML_PARENT_PREFIX_CHAR 0x5e
65	#define AML_NAME_CHAR__ 0x5f	65	#define AML_NAME_CHAR__ 0x5f
66	#define AML_LOCAL0 0x60	66	#define AML_LOCAL0 0x60
67	#define AML_LOCAL1 0x61	67	#define AML_LOCAL1 0x61
68	#define AML_LOCAL2 0x62	68	#define AML_LOCAL2 0x62
69	#define AML_LOCAL3 0x63	69	#define AML_LOCAL3 0x63
70	#define AML_LOCAL4 0x64	70	#define AML_LOCAL4 0x64
71	#define AML_LOCAL5 0x65	71	#define AML_LOCAL5 0x65
72	#define AML_LOCAL6 0x66	72	#define AML_LOCAL6 0x66
73	#define AML_LOCAL7 0x67	73	#define AML_LOCAL7 0x67
74	#define AML_ARG0 0x68	74	#define AML_ARG0 0x68
75	#define AML_ARG1 0x69	75	#define AML_ARG1 0x69
76	#define AML_ARG2 0x6a	76	#define AML_ARG2 0x6a
77	#define AML_ARG3 0x6b	77	#define AML_ARG3 0x6b
78	#define AML_ARG4 0x6c	78	#define AML_ARG4 0x6c
79	#define AML_ARG5 0x6d	79	#define AML_ARG5 0x6d
80	#define AML_ARG6 0x6e	80	#define AML_ARG6 0x6e
81	#define AML_STORE_OP 0x70	81	#define AML_STORE_OP 0x70
82	#define AML_REF_OF_OP 0x71	82	#define AML_REF_OF_OP 0x71
83	#define AML_ADD_OP 0x72	83	#define AML_ADD_OP 0x72
84	#define AML_CONCAT_OP 0x73	84	#define AML_CONCAT_OP 0x73
85	#define AML_SUBTRACT_OP 0x74	85	#define AML_SUBTRACT_OP 0x74
86	#define AML_INCREMENT_OP 0x75	86	#define AML_INCREMENT_OP 0x75
87	#define AML_DECREMENT_OP 0x76	87	#define AML_DECREMENT_OP 0x76
88	#define AML_MULTIPLY_OP 0x77	88	#define AML_MULTIPLY_OP 0x77
89	#define AML_DIVIDE_OP 0x78	89	#define AML_DIVIDE_OP 0x78
90	#define AML_SHIFT_LEFT_OP 0x79	90	#define AML_SHIFT_LEFT_OP 0x79
91	#define AML_SHIFT_RIGHT_OP 0x7a	91	#define AML_SHIFT_RIGHT_OP 0x7a
92	#define AML_AND_OP 0x7b	92	#define AML_AND_OP 0x7b
93	#define AML_NAND_OP 0x7c	93	#define AML_NAND_OP 0x7c
94	#define AML_OR_OP 0x7d	94	#define AML_OR_OP 0x7d
95	#define AML_NOR_OP 0x7e	95	#define AML_NOR_OP 0x7e
96	#define AML_XOR_OP 0x7f	96	#define AML_XOR_OP 0x7f
97	#define AML_NOT_OP 0x80	97	#define AML_NOT_OP 0x80
98	#define AML_FIND_SET_LEFT_BIT_OP 0x81	98	#define AML_FIND_SET_LEFT_BIT_OP 0x81
99	#define AML_FIND_SET_RIGHT_BIT_OP 0x82	99	#define AML_FIND_SET_RIGHT_BIT_OP 0x82
100	#define AML_DEREF_OF_OP 0x83	100	#define AML_DEREF_OF_OP 0x83
101	#define AML_CONCAT_RES_OP 0x84	101	#define AML_CONCAT_RES_OP 0x84
102	#define AML_MOD_OP 0x85	102	#define AML_MOD_OP 0x85
103	#define AML_NOTIFY_OP 0x86	103	#define AML_NOTIFY_OP 0x86
104	#define AML_SIZE_OF_OP 0x87	104	#define AML_SIZE_OF_OP 0x87
105	#define AML_INDEX_OP 0x88	105	#define AML_INDEX_OP 0x88
106	#define AML_MATCH_OP 0x89	106	#define AML_MATCH_OP 0x89
107	#define AML_CREATE_DWORD_FIELD_OP 0x8a	107	#define AML_CREATE_DWORD_FIELD_OP 0x8a
108	#define AML_CREATE_WORD_FIELD_OP 0x8b	108	#define AML_CREATE_WORD_FIELD_OP 0x8b
109	#define AML_CREATE_BYTE_FIELD_OP 0x8c	109	#define AML_CREATE_BYTE_FIELD_OP 0x8c
110	#define AML_CREATE_BIT_FIELD_OP 0x8d	110	#define AML_CREATE_BIT_FIELD_OP 0x8d
111	#define AML_OBJECT_TYPE_OP 0x8e	111	#define AML_OBJECT_TYPE_OP 0x8e
112	#define AML_CREATE_QWORD_FIELD_OP 0x8f	112	#define AML_CREATE_QWORD_FIELD_OP 0x8f
113	#define AML_LAND_OP 0x90	113	#define AML_LAND_OP 0x90
114	#define AML_LOR_OP 0x91	114	#define AML_LOR_OP 0x91
115	#define AML_LNOT_OP 0x92	115	#define AML_LNOT_OP 0x92
116	#define AML_LEQUAL_OP 0x93	116	#define AML_LEQUAL_OP 0x93
117	#define AML_LGREATER_OP 0x94	117	#define AML_LGREATER_OP 0x94
118	#define AML_LLESS_OP 0x95	118	#define AML_LLESS_OP 0x95
119	#define AML_TO_BUFFER_OP 0x96	119	#define AML_TO_BUFFER_OP 0x96
120	#define AML_TO_DEC_STRING_OP 0x97	120	#define AML_TO_DEC_STRING_OP 0x97
121	#define AML_TO_HEX_STRING_OP 0x98	121	#define AML_TO_HEX_STRING_OP 0x98
122	#define AML_TO_INTEGER_OP 0x99	122	#define AML_TO_INTEGER_OP 0x99
123	#define AML_TO_STRING_OP 0x9c	123	#define AML_TO_STRING_OP 0x9c
124	#define AML_COPY_OBJECT_OP 0x9d	124	#define AML_COPY_OBJECT_OP 0x9d
125	#define AML_MID_OP 0x9e	125	#define AML_MID_OP 0x9e
126	#define AML_CONTINUE_OP 0x9f	126	#define AML_CONTINUE_OP 0x9f
127	#define AML_IF_OP 0xa0	127	#define AML_IF_OP 0xa0
128	#define AML_ELSE_OP 0xa1	128	#define AML_ELSE_OP 0xa1
129	#define AML_WHILE_OP 0xa2	129	#define AML_WHILE_OP 0xa2
130	#define AML_NOOP_OP 0xa3	130	#define AML_NOOP_OP 0xa3
131	#define AML_RETURN_OP 0xa4	131	#define AML_RETURN_OP 0xa4
132	#define AML_BREAK_OP 0xa5	132	#define AML_BREAK_OP 0xa5
133	#define AML_BREAK_POINT_OP 0xcc	133	#define AML_BREAK_POINT_OP 0xcc
134	#define AML_ONES_OP 0xff	134	#define AML_ONES_OP 0xff
135		135
136	//	136	//
137	// Extended OpCode	137	// Extended OpCode
138	//	138	//
139	#define AML_EXT_OP 0x5b	139	#define AML_EXT_OP 0x5b
140		140
141	#define AML_EXT_MUTEX_OP 0x01	141	#define AML_EXT_MUTEX_OP 0x01
142	#define AML_EXT_EVENT_OP 0x02	142	#define AML_EXT_EVENT_OP 0x02
143	#define AML_EXT_COND_REF_OF_OP 0x12	143	#define AML_EXT_COND_REF_OF_OP 0x12
144	#define AML_EXT_CREATE_FIELD_OP 0x13	144	#define AML_EXT_CREATE_FIELD_OP 0x13
145	#define AML_EXT_LOAD_TABLE_OP 0x1f	145	#define AML_EXT_LOAD_TABLE_OP 0x1f
146	#define AML_EXT_LOAD_OP 0x20	146	#define AML_EXT_LOAD_OP 0x20
147	#define AML_EXT_STALL_OP 0x21	147	#define AML_EXT_STALL_OP 0x21
148	#define AML_EXT_SLEEP_OP 0x22	148	#define AML_EXT_SLEEP_OP 0x22
149	#define AML_EXT_ACQUIRE_OP 0x23	149	#define AML_EXT_ACQUIRE_OP 0x23
150	#define AML_EXT_SIGNAL_OP 0x24	150	#define AML_EXT_SIGNAL_OP 0x24
151	#define AML_EXT_WAIT_OP 0x25	151	#define AML_EXT_WAIT_OP 0x25
152	#define AML_EXT_RESET_OP 0x26	152	#define AML_EXT_RESET_OP 0x26
153	#define AML_EXT_RELEASE_OP 0x27	153	#define AML_EXT_RELEASE_OP 0x27
154	#define AML_EXT_FROM_BCD_OP 0x28	154	#define AML_EXT_FROM_BCD_OP 0x28
155	#define AML_EXT_TO_BCD_OP 0x29	155	#define AML_EXT_TO_BCD_OP 0x29
156	#define AML_EXT_UNLOAD_OP 0x2a	156	#define AML_EXT_UNLOAD_OP 0x2a
157	#define AML_EXT_REVISION_OP 0x30	157	#define AML_EXT_REVISION_OP 0x30
158	#define AML_EXT_DEBUG_OP 0x31	158	#define AML_EXT_DEBUG_OP 0x31
159	#define AML_EXT_FATAL_OP 0x32	159	#define AML_EXT_FATAL_OP 0x32
160	#define AML_EXT_TIMER_OP 0x33	160	#define AML_EXT_TIMER_OP 0x33
161	#define AML_EXT_REGION_OP 0x80	161	#define AML_EXT_REGION_OP 0x80
162	#define AML_EXT_FIELD_OP 0x81	162	#define AML_EXT_FIELD_OP 0x81
163	#define AML_EXT_DEVICE_OP 0x82	163	#define AML_EXT_DEVICE_OP 0x82
164	#define AML_EXT_PROCESSOR_OP 0x83	164	#define AML_EXT_PROCESSOR_OP 0x83
165	#define AML_EXT_POWER_RES_OP 0x84	165	#define AML_EXT_POWER_RES_OP 0x84
166	#define AML_EXT_THERMAL_ZONE_OP 0x85	166	#define AML_EXT_THERMAL_ZONE_OP 0x85
167	#define AML_EXT_INDEX_FIELD_OP 0x86	167	#define AML_EXT_INDEX_FIELD_OP 0x86
168	#define AML_EXT_BANK_FIELD_OP 0x87	168	#define AML_EXT_BANK_FIELD_OP 0x87
169	#define AML_EXT_DATA_REGION_OP 0x88	169	#define AML_EXT_DATA_REGION_OP 0x88
170		170
171	//	171	//
172	// FieldElement OpCode	172	// FieldElement OpCode
173	//	173	//
174	#define AML_FIELD_RESERVED_OP 0x00	174	#define AML_FIELD_RESERVED_OP 0x00
175	#define AML_FIELD_ACCESS_OP 0x01	175	#define AML_FIELD_ACCESS_OP 0x01
176	#define AML_FIELD_CONNECTION_OP 0x02	176	#define AML_FIELD_CONNECTION_OP 0x02
177	#define AML_FIELD_EXT_ACCESS_OP 0x03	177	#define AML_FIELD_EXT_ACCESS_OP 0x03
		178
		179	//
		180	// AML Name segment definitions
		181	//
		182	#define AML_NAME_SEG_SIZE 4
178		183
179	#endif	184	#endif

Lines 19-35 typedef struct { Link Here

(-)b/sys/contrib/edk2/Include/IndustryStandard/Bluetooth.h (-9 / +9 lines)
19	///	19	///
20	/// 48bit Bluetooth device address.	20	/// 48bit Bluetooth device address.
21	///	21	///
22	UINT8 Address[6];	22	UINT8 Address[6];
23	} BLUETOOTH_ADDRESS;	23	} BLUETOOTH_ADDRESS;
24		24
25	///	25	///
26	/// BLUETOOTH_CLASS_OF_DEVICE. See Bluetooth specification for detail.	26	/// BLUETOOTH_CLASS_OF_DEVICE. See Bluetooth specification for detail.
27	///	27	///
28	typedef struct {	28	typedef struct {
29	UINT8 FormatType:2;	29	UINT8 FormatType : 2;
30	UINT8 MinorDeviceClass: 6;	30	UINT8 MinorDeviceClass : 6;
31	UINT16 MajorDeviceClass: 5;	31	UINT16 MajorDeviceClass : 5;
32	UINT16 MajorServiceClass:11;	32	UINT16 MajorServiceClass : 11;
33	} BLUETOOTH_CLASS_OF_DEVICE;	33	} BLUETOOTH_CLASS_OF_DEVICE;
34		34
35	///	35	///
Lines 39-56 typedef struct { Link Here
39	///	39	///
40	/// 48-bit Bluetooth device address	40	/// 48-bit Bluetooth device address
41	///	41	///
42	UINT8 Address[6];	42	UINT8 Address[6];
43	///	43	///
44	/// 0x00 - Public Device Address	44	/// 0x00 - Public Device Address
45	/// 0x01 - Random Device Address	45	/// 0x01 - Random Device Address
46	///	46	///
47	UINT8 Type;	47	UINT8 Type;
48	} BLUETOOTH_LE_ADDRESS;	48	} BLUETOOTH_LE_ADDRESS;
49		49
50	#pragma pack()	50	#pragma pack()
51		51
52	#define BLUETOOTH_HCI_COMMAND_LOCAL_READABLE_NAME_MAX_SIZE 248	52	#define BLUETOOTH_HCI_COMMAND_LOCAL_READABLE_NAME_MAX_SIZE 248
53		53
54	#define BLUETOOTH_HCI_LINK_KEY_SIZE 16	54	#define BLUETOOTH_HCI_LINK_KEY_SIZE 16
55		55
56	#endif	56	#endif

Lines 29-54 SPDX-License-Identifier: BSD-2-Clause-Patent Link Here

(-)b/sys/contrib/edk2/Include/Library/DebugLib.h (-68 / +123 lines)
29	//	29	//
30	// Declare bits for PcdDebugPrintErrorLevel and the ErrorLevel parameter of DebugPrint()	30	// Declare bits for PcdDebugPrintErrorLevel and the ErrorLevel parameter of DebugPrint()
31	//	31	//
32	#define DEBUG_INIT 0x00000001 // Initialization	32	#define DEBUG_INIT 0x00000001 // Initialization
33	#define DEBUG_WARN 0x00000002 // Warnings	33	#define DEBUG_WARN 0x00000002 // Warnings
34	#define DEBUG_LOAD 0x00000004 // Load events	34	#define DEBUG_LOAD 0x00000004 // Load events
35	#define DEBUG_FS 0x00000008 // EFI File system	35	#define DEBUG_FS 0x00000008 // EFI File system
36	#define DEBUG_POOL 0x00000010 // Alloc & Free (pool)	36	#define DEBUG_POOL 0x00000010 // Alloc & Free (pool)
37	#define DEBUG_PAGE 0x00000020 // Alloc & Free (page)	37	#define DEBUG_PAGE 0x00000020 // Alloc & Free (page)
38	#define DEBUG_INFO 0x00000040 // Informational debug messages	38	#define DEBUG_INFO 0x00000040 // Informational debug messages
39	#define DEBUG_DISPATCH 0x00000080 // PEI/DXE/SMM Dispatchers	39	#define DEBUG_DISPATCH 0x00000080 // PEI/DXE/SMM Dispatchers
40	#define DEBUG_VARIABLE 0x00000100 // Variable	40	#define DEBUG_VARIABLE 0x00000100 // Variable
41	#define DEBUG_BM 0x00000400 // Boot Manager	41	#define DEBUG_BM 0x00000400 // Boot Manager
42	#define DEBUG_BLKIO 0x00001000 // BlkIo Driver	42	#define DEBUG_BLKIO 0x00001000 // BlkIo Driver
43	#define DEBUG_NET 0x00004000 // Network Io Driver	43	#define DEBUG_NET 0x00004000 // Network Io Driver
44	#define DEBUG_UNDI 0x00010000 // UNDI Driver	44	#define DEBUG_UNDI 0x00010000 // UNDI Driver
45	#define DEBUG_LOADFILE 0x00020000 // LoadFile	45	#define DEBUG_LOADFILE 0x00020000 // LoadFile
46	#define DEBUG_EVENT 0x00080000 // Event messages	46	#define DEBUG_EVENT 0x00080000 // Event messages
47	#define DEBUG_GCD 0x00100000 // Global Coherency Database changes	47	#define DEBUG_GCD 0x00100000 // Global Coherency Database changes
48	#define DEBUG_CACHE 0x00200000 // Memory range cachability changes	48	#define DEBUG_CACHE 0x00200000 // Memory range cachability changes
49	#define DEBUG_VERBOSE 0x00400000 // Detailed debug messages that may	49	#define DEBUG_VERBOSE 0x00400000 // Detailed debug messages that may
50	// significantly impact boot performance	50	// significantly impact boot performance
51	#define DEBUG_ERROR 0x80000000 // Error	51	#define DEBUG_MANAGEABILITY 0x00800000 // Detailed debug and payload manageability messages
		52	// related to modules such as Redfish, IPMI, MCTP etc.
		53	#define DEBUG_ERROR 0x80000000 // Error
52		54
53	//	55	//
54	// Aliases of debug message mask bits	56	// Aliases of debug message mask bits
Lines 71-76 SPDX-License-Identifier: BSD-2-Clause-Patent Link Here
71	#define EFI_D_VERBOSE DEBUG_VERBOSE	73	#define EFI_D_VERBOSE DEBUG_VERBOSE
72	#define EFI_D_ERROR DEBUG_ERROR	74	#define EFI_D_ERROR DEBUG_ERROR
73		75
		76	//
		77	// Source file line number.
		78	// Default is use the to compiler provided __LINE__ macro value. The __LINE__
		79	// mapping can be overriden by predefining DEBUG_LINE_NUMBER
		80	//
		81	// Defining DEBUG_LINE_NUMBER to a fixed value is useful when comparing builds
		82	// across source code formatting changes that may add/remove lines in a source
		83	// file.
		84	//
		85	#ifdef DEBUG_LINE_NUMBER
		86	#else
		87	#define DEBUG_LINE_NUMBER __LINE__
		88	#endif
		89
		90	/**
		91	Macro that converts a Boolean expression to a Null-terminated ASCII string.
		92
		93	The default is to use the C pre-processor stringizing operator '#' to add
		94	quotes around the C expression. If DEBUG_EXPRESSION_STRING_VALUE is defined
		95	then the C expression is converted to the fixed string value.
		96
		97	Defining DEBUG_EXPRESSION_STRING_VALUE to a fixed value is useful when
		98	comparing builds across source code formatting changes that may make
		99	changes to spaces or parenthesis in a Boolean expression.
		100
		101	@param Expression Boolean expression.
		102
		103	**/
		104
		105	#ifdef DEBUG_EXPRESSION_STRING_VALUE
		106	#define DEBUG_EXPRESSION_STRING(Expression) DEBUG_EXPRESSION_STRING_VALUE
		107	#else
		108	#define DEBUG_EXPRESSION_STRING(Expression) #Expression
		109	#endif
		110
74	/**	111	/**
75	Prints a debug message to the debug output device if the specified error level is enabled.	112	Prints a debug message to the debug output device if the specified error level is enabled.
76		113
Lines 94-100 DebugPrint ( Link Here
94	...	131	...
95	);	132	);
96		133
97
98	/**	134	/**
99	Prints a debug message to the debug output device if the specified	135	Prints a debug message to the debug output device if the specified
100	error level is enabled.	136	error level is enabled.
Lines 113-124 DebugPrint ( Link Here
113	VOID	149	VOID
114	EFIAPI	150	EFIAPI
115	DebugVPrint (	151	DebugVPrint (
116	IN UINTN ErrorLevel,	152	IN UINTN ErrorLevel,
117	IN CONST CHAR8 *Format,	153	IN CONST CHAR8 *Format,
118	IN VA_LIST VaListMarker	154	IN VA_LIST VaListMarker
119	);	155	);
120		156
121
122	/**	157	/**
123	Prints a debug message to the debug output device if the specified	158	Prints a debug message to the debug output device if the specified
124	error level is enabled.	159	error level is enabled.
Lines 139-150 DebugVPrint ( Link Here
139	VOID	174	VOID
140	EFIAPI	175	EFIAPI
141	DebugBPrint (	176	DebugBPrint (
142	IN UINTN ErrorLevel,	177	IN UINTN ErrorLevel,
143	IN CONST CHAR8 *Format,	178	IN CONST CHAR8 *Format,
144	IN BASE_LIST BaseListMarker	179	IN BASE_LIST BaseListMarker
145	);	180	);
146		181
147
148	/**	182	/**
149	Prints an assert message containing a filename, line number, and description.	183	Prints an assert message containing a filename, line number, and description.
150	This may be followed by a breakpoint or a dead loop.	184	This may be followed by a breakpoint or a dead loop.
Lines 174-180 DebugAssert ( Link Here
174	IN CONST CHAR8 *Description	208	IN CONST CHAR8 *Description
175	);	209	);
176		210
177
178	/**	211	/**
179	Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.	212	Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.
180		213
Lines 197-203 DebugClearMemory ( Link Here
197	IN UINTN Length	230	IN UINTN Length
198	);	231	);
199		232
200
201	/**	233	/**
202	Returns TRUE if ASSERT() macros are enabled.	234	Returns TRUE if ASSERT() macros are enabled.
203		235
Lines 214-220 DebugAssertEnabled ( Link Here
214	VOID	246	VOID
215	);	247	);
216		248
217
218	/**	249	/**
219	Returns TRUE if DEBUG() macros are enabled.	250	Returns TRUE if DEBUG() macros are enabled.
220		251
Lines 231-237 DebugPrintEnabled ( Link Here
231	VOID	262	VOID
232	);	263	);
233		264
234
235	/**	265	/**
236	Returns TRUE if DEBUG_CODE() macros are enabled.	266	Returns TRUE if DEBUG_CODE() macros are enabled.
237		267
Lines 248-254 DebugCodeEnabled ( Link Here
248	VOID	278	VOID
249	);	279	);
250		280
251
252	/**	281	/**
253	Returns TRUE if DEBUG_CLEAR_MEMORY() macro is enabled.	282	Returns TRUE if DEBUG_CLEAR_MEMORY() macro is enabled.
254		283
Lines 277-283 DebugClearMemoryEnabled ( Link Here
277	BOOLEAN	306	BOOLEAN
278	EFIAPI	307	EFIAPI
279	DebugPrintLevelEnabled (	308	DebugPrintLevelEnabled (
280	IN CONST UINTN ErrorLevel	309	IN CONST UINTN ErrorLevel
281	);	310	);
282		311
283	/**	312	/**
Lines 289-301 DebugPrintLevelEnabled ( Link Here
289	@param Expression Boolean expression that evaluated to FALSE	318	@param Expression Boolean expression that evaluated to FALSE
290		319
291	**/	320	**/
292	#if defined(__clang__) && defined(__FILE_NAME__)	321	#if defined (EDKII_UNIT_TEST_FRAMEWORK_ENABLED)
293	#define _ASSERT(Expression) DebugAssert (__FILE_NAME__, __LINE__, #Expression)	322
		323	/**
		324	Unit test library replacement for DebugAssert() in DebugLib.
		325
		326	If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed.
		327	If Description is NULL, then a <Description> string of "(NULL) Description" is printed.
		328
		329	@param FileName The pointer to the name of the source file that generated the assert condition.
		330	@param LineNumber The line number in the source file that generated the assert condition
		331	@param Description The pointer to the description of the assert condition.
		332
		333	**/
		334	VOID
		335	EFIAPI
		336	UnitTestDebugAssert (
		337	IN CONST CHAR8 *FileName,
		338	IN UINTN LineNumber,
		339	IN CONST CHAR8 *Description
		340	);
		341
		342	#if defined (_ASSERT)
		343	#undef _ASSERT
		344	#endif
		345	#if defined (__clang__) && defined (__FILE_NAME__)
		346	#define _ASSERT(Expression) UnitTestDebugAssert (__FILE_NAME__, DEBUG_LINE_NUMBER, DEBUG_EXPRESSION_STRING (Expression))
		347	#else
		348	#define _ASSERT(Expression) UnitTestDebugAssert (__FILE__, DEBUG_LINE_NUMBER, DEBUG_EXPRESSION_STRING (Expression))
		349	#endif
294	#else	350	#else
295	#define _ASSERT(Expression) DebugAssert (__FILE__, __LINE__, #Expression)	351	#if defined (__clang__) && defined (__FILE_NAME__)
		352	#define _ASSERT(Expression) DebugAssert (__FILE_NAME__, DEBUG_LINE_NUMBER, DEBUG_EXPRESSION_STRING (Expression))
		353	#else
		354	#define _ASSERT(Expression) DebugAssert (__FILE__, DEBUG_LINE_NUMBER, DEBUG_EXPRESSION_STRING (Expression))
		355	#endif
296	#endif	356	#endif
297		357
298
299	/**	358	/**
300	Internal worker macro that calls DebugPrint().	359	Internal worker macro that calls DebugPrint().
301		360
Lines 309-324 DebugPrintLevelEnabled ( Link Here
309		368
310	**/	369	**/
311		370
312	#if !defined(MDE_CPU_EBC) && (!defined (_MSC_VER) \|\| _MSC_VER > 1400)	371	#if !defined (MDE_CPU_EBC) && (!defined (_MSC_VER) \|\| _MSC_VER > 1400)
313	#define _DEBUG_PRINT(PrintLevel, ...) \	372	#define _DEBUG_PRINT(PrintLevel, ...) \
314	do { \	373	do { \
315	if (DebugPrintLevelEnabled (PrintLevel)) { \	374	if (DebugPrintLevelEnabled (PrintLevel)) { \
316	DebugPrint (PrintLevel, ##__VA_ARGS__); \	375	DebugPrint (PrintLevel, ##__VA_ARGS__); \
317	} \	376	} \
318	} while (FALSE)	377	} while (FALSE)
319	#define _DEBUG(Expression) _DEBUG_PRINT Expression	378	#define _DEBUGLIB_DEBUG(Expression) _DEBUG_PRINT Expression
320	#else	379	#else
321	#define _DEBUG(Expression) DebugPrint Expression	380	#define _DEBUGLIB_DEBUG(Expression) DebugPrint Expression
322	#endif	381	#endif
323		382
324	/**	383	/**
Lines 333-340 DebugPrintLevelEnabled ( Link Here
333	@param Expression Boolean expression.	392	@param Expression Boolean expression.
334		393
335	**/	394	**/
336	#if !defined(MDEPKG_NDEBUG)	395	#if !defined (MDEPKG_NDEBUG)
337	#define ASSERT(Expression) \	396	#define ASSERT(Expression) \
338	do { \	397	do { \
339	if (DebugAssertEnabled ()) { \	398	if (DebugAssertEnabled ()) { \
340	if (!(Expression)) { \	399	if (!(Expression)) { \
Lines 344-350 DebugPrintLevelEnabled ( Link Here
344	} \	403	} \
345	} while (FALSE)	404	} while (FALSE)
346	#else	405	#else
347	#define ASSERT(Expression)	406	#define ASSERT(Expression)
348	#endif	407	#endif
349		408
350	/**	409	/**
Lines 359-373 DebugPrintLevelEnabled ( Link Here
359		418
360		419
361	**/	420	**/
362	#if !defined(MDEPKG_NDEBUG)	421	#if !defined (MDEPKG_NDEBUG)
363	#define DEBUG(Expression) \	422	#define DEBUG(Expression) \
364	do { \	423	do { \
365	if (DebugPrintEnabled ()) { \	424	if (DebugPrintEnabled ()) { \
366	_DEBUG (Expression); \	425	_DEBUGLIB_DEBUG (Expression); \
367	} \	426	} \
368	} while (FALSE)	427	} while (FALSE)
369	#else	428	#else
370	#define DEBUG(Expression)	429	#define DEBUG(Expression)
371	#endif	430	#endif
372		431
373	/**	432	/**
Lines 382-399 DebugPrintLevelEnabled ( Link Here
382	@param StatusParameter EFI_STATUS value to evaluate.	441	@param StatusParameter EFI_STATUS value to evaluate.
383		442
384	**/	443	**/
385	#if !defined(MDEPKG_NDEBUG)	444	#if !defined (MDEPKG_NDEBUG)
386	#define ASSERT_EFI_ERROR(StatusParameter) \	445	#define ASSERT_EFI_ERROR(StatusParameter) \
387	do { \	446	do { \
388	if (DebugAssertEnabled ()) { \	447	if (DebugAssertEnabled ()) { \
389	if (EFI_ERROR (StatusParameter)) { \	448	if (EFI_ERROR (StatusParameter)) { \
390	DEBUG ((EFI_D_ERROR, "\nASSERT_EFI_ERROR (Status = %r)\n", StatusParameter)); \	449	DEBUG ((DEBUG_ERROR, "\nASSERT_EFI_ERROR (Status = %r)\n", StatusParameter)); \
391	_ASSERT (!EFI_ERROR (StatusParameter)); \	450	_ASSERT (!EFI_ERROR (StatusParameter)); \
392	} \	451	} \
393	} \	452	} \
394	} while (FALSE)	453	} while (FALSE)
395	#else	454	#else
396	#define ASSERT_EFI_ERROR(StatusParameter)	455	#define ASSERT_EFI_ERROR(StatusParameter)
397	#endif	456	#endif
398		457
399	/**	458	/**
Lines 408-415 DebugPrintLevelEnabled ( Link Here
408	@param StatusParameter RETURN_STATUS value to evaluate.	467	@param StatusParameter RETURN_STATUS value to evaluate.
409		468
410	**/	469	**/
411	#if !defined(MDEPKG_NDEBUG)	470	#if !defined (MDEPKG_NDEBUG)
412	#define ASSERT_RETURN_ERROR(StatusParameter) \	471	#define ASSERT_RETURN_ERROR(StatusParameter) \
413	do { \	472	do { \
414	if (DebugAssertEnabled ()) { \	473	if (DebugAssertEnabled ()) { \
415	if (RETURN_ERROR (StatusParameter)) { \	474	if (RETURN_ERROR (StatusParameter)) { \
Lines 420-426 DebugPrintLevelEnabled ( Link Here
420	} \	479	} \
421	} while (FALSE)	480	} while (FALSE)
422	#else	481	#else
423	#define ASSERT_RETURN_ERROR(StatusParameter)	482	#define ASSERT_RETURN_ERROR(StatusParameter)
424	#endif	483	#endif
425		484
426	/**	485	/**
Lines 445-452 DebugPrintLevelEnabled ( Link Here
445	@param Guid The pointer to a protocol GUID.	504	@param Guid The pointer to a protocol GUID.
446		505
447	**/	506	**/
448	#if !defined(MDEPKG_NDEBUG)	507	#if !defined (MDEPKG_NDEBUG)
449	#define ASSERT_PROTOCOL_ALREADY_INSTALLED(Handle, Guid) \	508	#define ASSERT_PROTOCOL_ALREADY_INSTALLED(Handle, Guid) \
450	do { \	509	do { \
451	if (DebugAssertEnabled ()) { \	510	if (DebugAssertEnabled ()) { \
452	VOID *Instance; \	511	VOID *Instance; \
Lines 463-469 DebugPrintLevelEnabled ( Link Here
463	} \	522	} \
464	} while (FALSE)	523	} while (FALSE)
465	#else	524	#else
466	#define ASSERT_PROTOCOL_ALREADY_INSTALLED(Handle, Guid)	525	#define ASSERT_PROTOCOL_ALREADY_INSTALLED(Handle, Guid)
467	#endif	526	#endif
468		527
469	/**	528	/**
Lines 477-483 DebugPrintLevelEnabled ( Link Here
477	**/	536	**/
478	#define DEBUG_CODE_BEGIN() do { if (DebugCodeEnabled ()) { UINT8 __DebugCodeLocal	537	#define DEBUG_CODE_BEGIN() do { if (DebugCodeEnabled ()) { UINT8 __DebugCodeLocal
479		538
480
481	/**	539	/**
482	The macro that marks the end of debug source code.	540	The macro that marks the end of debug source code.
483		541
Lines 487-494 DebugPrintLevelEnabled ( Link Here
487	are not included in a module.	545	are not included in a module.
488		546
489	**/	547	**/
490	#define DEBUG_CODE_END() __DebugCodeLocal = 0; __DebugCodeLocal++; } } while (FALSE)	548	#define DEBUG_CODE_END() __DebugCodeLocal = 0; __DebugCodeLocal++; } } while (FALSE)
491
492		549
493	/**	550	/**
494	The macro that declares a section of debug source code.	551	The macro that declares a section of debug source code.
Lines 503-509 DebugPrintLevelEnabled ( Link Here
503	Expression \	560	Expression \
504	DEBUG_CODE_END ()	561	DEBUG_CODE_END ()
505		562
506
507	/**	563	/**
508	The macro that calls DebugClearMemory() to clear a buffer to a default value.	564	The macro that calls DebugClearMemory() to clear a buffer to a default value.
509		565
Lines 521-527 DebugPrintLevelEnabled ( Link Here
521	} \	577	} \
522	} while (FALSE)	578	} while (FALSE)
523		579
524
525	/**	580	/**
526	Macro that calls DebugAssert() if the containing record does not have a	581	Macro that calls DebugAssert() if the containing record does not have a
527	matching signature. If the signatures matches, then a pointer to the data	582	matching signature. If the signatures matches, then a pointer to the data
Lines 564-576 DebugPrintLevelEnabled ( Link Here
564	@param TestSignature The 32-bit signature value to match.	619	@param TestSignature The 32-bit signature value to match.
565		620
566	**/	621	**/
567	#if !defined(MDEPKG_NDEBUG)	622	#if !defined (MDEPKG_NDEBUG)
568	#define CR(Record, TYPE, Field, TestSignature) \	623	#define CR(Record, TYPE, Field, TestSignature) \
569	(DebugAssertEnabled () && (BASE_CR (Record, TYPE, Field)->Signature != TestSignature)) ? \	624	(DebugAssertEnabled () && (BASE_CR (Record, TYPE, Field)->Signature != TestSignature)) ? \
570	(TYPE *) (_ASSERT (CR has Bad Signature), Record) : \	625	(TYPE *) (_ASSERT (CR has Bad Signature), Record) : \
571	BASE_CR (Record, TYPE, Field)	626	BASE_CR (Record, TYPE, Field)
572	#else	627	#else
573	#define CR(Record, TYPE, Field, TestSignature) \	628	#define CR(Record, TYPE, Field, TestSignature) \
574	BASE_CR (Record, TYPE, Field)	629	BASE_CR (Record, TYPE, Field)
575	#endif	630	#endif
576		631

Lines 12-18 SPDX-License-Identifier: BSD-2-Clause-Patent Link Here

(-)b/sys/contrib/edk2/Include/Library/DevicePathLib.h (-19 / +19 lines)
12	#ifndef __DEVICE_PATH_LIB_H__	12	#ifndef __DEVICE_PATH_LIB_H__
13	#define __DEVICE_PATH_LIB_H__	13	#define __DEVICE_PATH_LIB_H__
14		14
15	#define END_DEVICE_PATH_LENGTH (sizeof (EFI_DEVICE_PATH_PROTOCOL))	15	#define END_DEVICE_PATH_LENGTH (sizeof (EFI_DEVICE_PATH_PROTOCOL))
16		16
17	/**	17	/**
18	Determine whether a given device path is valid.	18	Determine whether a given device path is valid.
Lines 33-40 SPDX-License-Identifier: BSD-2-Clause-Patent Link Here
33	BOOLEAN	33	BOOLEAN
34	EFIAPI	34	EFIAPI
35	IsDevicePathValid (	35	IsDevicePathValid (
36	IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath,	36	IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath,
37	IN UINTN MaxSize	37	IN UINTN MaxSize
38	);	38	);
39		39
40	/**	40	/**
Lines 292-298 DuplicateDevicePath ( Link Here
292	EFI_DEVICE_PATH_PROTOCOL *	292	EFI_DEVICE_PATH_PROTOCOL *
293	EFIAPI	293	EFIAPI
294	AppendDevicePath (	294	AppendDevicePath (
295	IN CONST EFI_DEVICE_PATH_PROTOCOL *FirstDevicePath, OPTIONAL	295	IN CONST EFI_DEVICE_PATH_PROTOCOL *FirstDevicePath OPTIONAL,
296	IN CONST EFI_DEVICE_PATH_PROTOCOL *SecondDevicePath OPTIONAL	296	IN CONST EFI_DEVICE_PATH_PROTOCOL *SecondDevicePath OPTIONAL
297	);	297	);
298		298
Lines 324-330 AppendDevicePath ( Link Here
324	EFI_DEVICE_PATH_PROTOCOL *	324	EFI_DEVICE_PATH_PROTOCOL *
325	EFIAPI	325	EFIAPI
326	AppendDevicePathNode (	326	AppendDevicePathNode (
327	IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath, OPTIONAL	327	IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath OPTIONAL,
328	IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePathNode OPTIONAL	328	IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePathNode OPTIONAL
329	);	329	);
330		330
Lines 352-358 AppendDevicePathNode ( Link Here
352	EFI_DEVICE_PATH_PROTOCOL *	352	EFI_DEVICE_PATH_PROTOCOL *
353	EFIAPI	353	EFIAPI
354	AppendDevicePathInstance (	354	AppendDevicePathInstance (
355	IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath, OPTIONAL	355	IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath OPTIONAL,
356	IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePathInstance OPTIONAL	356	IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePathInstance OPTIONAL
357	);	357	);
358		358
Lines 384-391 AppendDevicePathInstance ( Link Here
384	EFI_DEVICE_PATH_PROTOCOL *	384	EFI_DEVICE_PATH_PROTOCOL *
385	EFIAPI	385	EFIAPI
386	GetNextDevicePathInstance (	386	GetNextDevicePathInstance (
387	IN OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath,	387	IN OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath,
388	OUT UINTN *Size	388	OUT UINTN *Size
389	);	389	);
390		390
391	/**	391	/**
Lines 409-417 GetNextDevicePathInstance ( Link Here
409	EFI_DEVICE_PATH_PROTOCOL *	409	EFI_DEVICE_PATH_PROTOCOL *
410	EFIAPI	410	EFIAPI
411	CreateDeviceNode (	411	CreateDeviceNode (
412	IN UINT8 NodeType,	412	IN UINT8 NodeType,
413	IN UINT8 NodeSubType,	413	IN UINT8 NodeSubType,
414	IN UINT16 NodeLength	414	IN UINT16 NodeLength
415	);	415	);
416		416
417	/**	417	/**
Lines 447-453 IsDevicePathMultiInstance ( Link Here
447	EFI_DEVICE_PATH_PROTOCOL *	447	EFI_DEVICE_PATH_PROTOCOL *
448	EFIAPI	448	EFIAPI
449	DevicePathFromHandle (	449	DevicePathFromHandle (
450	IN EFI_HANDLE Handle	450	IN EFI_HANDLE Handle
451	);	451	);
452		452
453	/**	453	/**
Lines 474-481 DevicePathFromHandle ( Link Here
474	EFI_DEVICE_PATH_PROTOCOL *	474	EFI_DEVICE_PATH_PROTOCOL *
475	EFIAPI	475	EFIAPI
476	FileDevicePath (	476	FileDevicePath (
477	IN EFI_HANDLE Device, OPTIONAL	477	IN EFI_HANDLE Device OPTIONAL,
478	IN CONST CHAR16 *FileName	478	IN CONST CHAR16 *FileName
479	);	479	);
480		480
481	/**	481	/**
Lines 496-504 FileDevicePath ( Link Here
496	CHAR16 *	496	CHAR16 *
497	EFIAPI	497	EFIAPI
498	ConvertDevicePathToText (	498	ConvertDevicePathToText (
499	IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath,	499	IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath,
500	IN BOOLEAN DisplayOnly,	500	IN BOOLEAN DisplayOnly,
501	IN BOOLEAN AllowShortcuts	501	IN BOOLEAN AllowShortcuts
502	);	502	);
503		503
504	/**	504	/**
Lines 538-544 ConvertDeviceNodeToText ( Link Here
538	EFI_DEVICE_PATH_PROTOCOL *	538	EFI_DEVICE_PATH_PROTOCOL *
539	EFIAPI	539	EFIAPI
540	ConvertTextToDeviceNode (	540	ConvertTextToDeviceNode (
541	IN CONST CHAR16 *TextDeviceNode	541	IN CONST CHAR16 *TextDeviceNode
542	);	542	);
543		543
544	/**	544	/**
Lines 555-561 ConvertTextToDeviceNode ( Link Here
555	EFI_DEVICE_PATH_PROTOCOL *	555	EFI_DEVICE_PATH_PROTOCOL *
556	EFIAPI	556	EFIAPI
557	ConvertTextToDevicePath (	557	ConvertTextToDevicePath (
558	IN CONST CHAR16 *TextDevicePath	558	IN CONST CHAR16 *TextDevicePath
559	);	559	);
560		560
561	#endif	561	#endif

Lines 192-201 SPDX-License-Identifier: BSD-2-Clause-Patent Link Here

(-)b/sys/contrib/edk2/Include/Library/PrintLib.h (-131 / +20 lines)
192	/// Flags bitmask values use in UnicodeValueToString() and	192	/// Flags bitmask values use in UnicodeValueToString() and
193	/// AsciiValueToString()	193	/// AsciiValueToString()
194	///	194	///
195	#define LEFT_JUSTIFY 0x01	195	#define LEFT_JUSTIFY 0x01
196	#define COMMA_TYPE 0x08	196	#define COMMA_TYPE 0x08
197	#define PREFIX_ZERO 0x20	197	#define PREFIX_ZERO 0x20
198	#define RADIX_HEX 0x80	198	#define RADIX_HEX 0x80
199		199
200	/**	200	/**
201	Produces a Null-terminated Unicode string in an output buffer based on	201	Produces a Null-terminated Unicode string in an output buffer based on
Lines 485-546 UnicodeSPrintAsciiFormat ( Link Here
485	...	485	...
486	);	486	);
487		487
488	#ifndef DISABLE_NEW_DEPRECATED_INTERFACES
489
490	/**
491	[ATTENTION] This function is deprecated for security reason.
492
493	Converts a decimal value to a Null-terminated Unicode string.
494
495	Converts the decimal number specified by Value to a Null-terminated Unicode
496	string specified by Buffer containing at most Width characters. No padding of spaces
497	is ever performed. If Width is 0 then a width of MAXIMUM_VALUE_CHARACTERS is assumed.
498	The number of Unicode characters in Buffer is returned, not including the Null-terminator.
499	If the conversion contains more than Width characters, then only the first
500	Width characters are returned, and the total number of characters
501	required to perform the conversion is returned.
502	Additional conversion parameters are specified in Flags.
503
504	The Flags bit LEFT_JUSTIFY is always ignored.
505	All conversions are left justified in Buffer.
506	If Width is 0, PREFIX_ZERO is ignored in Flags.
507	If COMMA_TYPE is set in Flags, then PREFIX_ZERO is ignored in Flags, and commas
508	are inserted every 3rd digit starting from the right.
509	If RADIX_HEX is set in Flags, then the output buffer will be
510	formatted in hexadecimal format.
511	If Value is < 0 and RADIX_HEX is not set in Flags, then the fist character in Buffer is a '-'.
512	If PREFIX_ZERO is set in Flags and PREFIX_ZERO is not being ignored,
513	then Buffer is padded with '0' characters so the combination of the optional '-'
514	sign character, '0' characters, digit characters for Value, and the Null-terminator
515	add up to Width characters.
516	If both COMMA_TYPE and RADIX_HEX are set in Flags, then ASSERT().
517	If Buffer is NULL, then ASSERT().
518	If Buffer is not aligned on a 16-bit boundary, then ASSERT().
519	If unsupported bits are set in Flags, then ASSERT().
520	If both COMMA_TYPE and RADIX_HEX are set in Flags, then ASSERT().
521	If Width >= MAXIMUM_VALUE_CHARACTERS, then ASSERT()
522
523	@param Buffer The pointer to the output buffer for the produced Null-terminated
524	Unicode string.
525	@param Flags The bitmask of flags that specify left justification, zero pad, and commas.
526	@param Value The 64-bit signed value to convert to a string.
527	@param Width The maximum number of Unicode characters to place in Buffer, not including
528	the Null-terminator.
529
530	@return The number of Unicode characters in Buffer, not including the Null-terminator.
531
532	**/
533	UINTN
534	EFIAPI
535	UnicodeValueToString (
536	IN OUT CHAR16 *Buffer,
537	IN UINTN Flags,
538	IN INT64 Value,
539	IN UINTN Width
540	);
541
542	#endif
543
544	/**	488	/**
545	Converts a decimal value to a Null-terminated Unicode string.	489	Converts a decimal value to a Null-terminated Unicode string.
546		490
Lines 642-651 UnicodeValueToStringS ( Link Here
642	UINTN	586	UINTN
643	EFIAPI	587	EFIAPI
644	AsciiVSPrint (	588	AsciiVSPrint (
645	OUT CHAR8 *StartOfBuffer,	589	OUT CHAR8 *StartOfBuffer,
646	IN UINTN BufferSize,	590	IN UINTN BufferSize,
647	IN CONST CHAR8 *FormatString,	591	IN CONST CHAR8 *FormatString,
648	IN VA_LIST Marker	592	IN VA_LIST Marker
649	);	593	);
650		594
651	/**	595	/**
Lines 686-695 AsciiVSPrint ( Link Here
686	UINTN	630	UINTN
687	EFIAPI	631	EFIAPI
688	AsciiBSPrint (	632	AsciiBSPrint (
689	OUT CHAR8 *StartOfBuffer,	633	OUT CHAR8 *StartOfBuffer,
690	IN UINTN BufferSize,	634	IN UINTN BufferSize,
691	IN CONST CHAR8 *FormatString,	635	IN CONST CHAR8 *FormatString,
692	IN BASE_LIST Marker	636	IN BASE_LIST Marker
693	);	637	);
694		638
695	/**	639	/**
Lines 882-942 AsciiSPrintUnicodeFormat ( Link Here
882	...	826	...
883	);	827	);
884		828
885	#ifndef DISABLE_NEW_DEPRECATED_INTERFACES
886
887	/**
888	[ATTENTION] This function is deprecated for security reason.
889
890	Converts a decimal value to a Null-terminated ASCII string.
891
892	Converts the decimal number specified by Value to a Null-terminated ASCII string
893	specified by Buffer containing at most Width characters. No padding of spaces
894	is ever performed.
895	If Width is 0 then a width of MAXIMUM_VALUE_CHARACTERS is assumed.
896	The number of ASCII characters in Buffer is returned, not including the Null-terminator.
897	If the conversion contains more than Width characters, then only the first Width
898	characters are returned, and the total number of characters required to perform
899	the conversion is returned.
900	Additional conversion parameters are specified in Flags.
901	The Flags bit LEFT_JUSTIFY is always ignored.
902	All conversions are left justified in Buffer.
903	If Width is 0, PREFIX_ZERO is ignored in Flags.
904	If COMMA_TYPE is set in Flags, then PREFIX_ZERO is ignored in Flags, and commas
905	are inserted every 3rd digit starting from the right.
906	If RADIX_HEX is set in Flags, then the output buffer will be
907	formatted in hexadecimal format.
908	If Value is < 0 and RADIX_HEX is not set in Flags, then the fist character in Buffer is a '-'.
909	If PREFIX_ZERO is set in Flags and PREFIX_ZERO is not being ignored,
910	then Buffer is padded with '0' characters so the combination of the optional '-'
911	sign character, '0' characters, digit characters for Value, and the Null-terminator
912	add up to Width characters.
913
914	If Buffer is NULL, then ASSERT().
915	If unsupported bits are set in Flags, then ASSERT().
916	If both COMMA_TYPE and RADIX_HEX are set in Flags, then ASSERT().
917	If Width >= MAXIMUM_VALUE_CHARACTERS, then ASSERT()
918
919	@param Buffer A pointer to the output buffer for the produced Null-terminated
920	ASCII string.
921	@param Flags The bitmask of flags that specify left justification, zero pad, and commas.
922	@param Value The 64-bit signed value to convert to a string.
923	@param Width The maximum number of ASCII characters to place in Buffer, not including
924	the Null-terminator.
925
926	@return The number of ASCII characters in Buffer, not including the Null-terminator.
927
928	**/
929	UINTN
930	EFIAPI
931	AsciiValueToString (
932	OUT CHAR8 *Buffer,
933	IN UINTN Flags,
934	IN INT64 Value,
935	IN UINTN Width
936	);
937
938	#endif
939
940	/**	829	/**
941	Converts a decimal value to a Null-terminated Ascii string.	830	Converts a decimal value to a Null-terminated Ascii string.
942		831
Lines 989-999 AsciiValueToString ( Link Here
989	RETURN_STATUS	878	RETURN_STATUS
990	EFIAPI	879	EFIAPI
991	AsciiValueToStringS (	880	AsciiValueToStringS (
992	IN OUT CHAR8 *Buffer,	881	IN OUT CHAR8 *Buffer,
993	IN UINTN BufferSize,	882	IN UINTN BufferSize,
994	IN UINTN Flags,	883	IN UINTN Flags,
995	IN INT64 Value,	884	IN INT64 Value,
996	IN UINTN Width	885	IN UINTN Width
997	);	886	);
998		887
999	/**	888	/**
Lines 1016-1022 AsciiValueToStringS ( Link Here
1016	UINTN	905	UINTN
1017	EFIAPI	906	EFIAPI
1018	SPrintLength (	907	SPrintLength (
1019	IN CONST CHAR16 *FormatString,	908	IN CONST CHAR16 *FormatString,
1020	IN VA_LIST Marker	909	IN VA_LIST Marker
1021	);	910	);
1022		911
Lines 1038-1045 SPrintLength ( Link Here
1038	UINTN	927	UINTN
1039	EFIAPI	928	EFIAPI
1040	SPrintLengthAsciiFormat (	929	SPrintLengthAsciiFormat (
1041	IN CONST CHAR8 *FormatString,	930	IN CONST CHAR8 *FormatString,
1042	IN VA_LIST Marker	931	IN VA_LIST Marker
1043	);	932	);
1044		933
1045	#endif	934	#endif

Lines 13-24 SPDX-License-Identifier: BSD-2-Clause-Patent Link Here

(-)b/sys/contrib/edk2/Include/Library/UefiBootServicesTableLib.h (-2 / +2 lines)
13	///	13	///
14	/// Cache the Image Handle	14	/// Cache the Image Handle
15	///	15	///
16	extern EFI_HANDLE gImageHandle;	16	extern EFI_HANDLE gImageHandle;
17		17
18	///	18	///
19	/// Cache pointer to the EFI System Table	19	/// Cache pointer to the EFI System Table
20	///	20	///
21	extern EFI_SYSTEM_TABLE *gST;	21	extern EFI_SYSTEM_TABLE *gST;
22		22
23	///	23	///
24	/// Cache pointer to the EFI Boot Services Table	24	/// Cache pointer to the EFI Boot Services Table

Lines 12-18 Link Here

(-)b/sys/contrib/edk2/Include/Protocol/DebugPort.h (-11 / +10 lines)
12	#ifndef __DEBUG_PORT_H__	12	#ifndef __DEBUG_PORT_H__
13	#define __DEBUG_PORT_H__	13	#define __DEBUG_PORT_H__
14		14
15
16	///	15	///
17	/// DebugPortIo protocol {EBA4E8D2-3858-41EC-A281-2647BA9660D0}	16	/// DebugPortIo protocol {EBA4E8D2-3858-41EC-A281-2647BA9660D0}
18	///	17	///
Lines 21-27 Link Here
21	0xEBA4E8D2, 0x3858, 0x41EC, {0xA2, 0x81, 0x26, 0x47, 0xBA, 0x96, 0x60, 0xD0 } \	20	0xEBA4E8D2, 0x3858, 0x41EC, {0xA2, 0x81, 0x26, 0x47, 0xBA, 0x96, 0x60, 0xD0 } \
22	}	21	}
23		22
24	extern EFI_GUID gEfiDebugPortProtocolGuid;	23	extern EFI_GUID gEfiDebugPortProtocolGuid;
25		24
26	typedef struct _EFI_DEBUGPORT_PROTOCOL EFI_DEBUGPORT_PROTOCOL;	25	typedef struct _EFI_DEBUGPORT_PROTOCOL EFI_DEBUGPORT_PROTOCOL;
27		26
Lines 111-140 EFI_STATUS Link Here
111	/// This protocol provides the communication link between the debug agent and the remote host.	110	/// This protocol provides the communication link between the debug agent and the remote host.
112	///	111	///
113	struct _EFI_DEBUGPORT_PROTOCOL {	112	struct _EFI_DEBUGPORT_PROTOCOL {
114	EFI_DEBUGPORT_RESET Reset;	113	EFI_DEBUGPORT_RESET Reset;
115	EFI_DEBUGPORT_WRITE Write;	114	EFI_DEBUGPORT_WRITE Write;
116	EFI_DEBUGPORT_READ Read;	115	EFI_DEBUGPORT_READ Read;
117	EFI_DEBUGPORT_POLL Poll;	116	EFI_DEBUGPORT_POLL Poll;
118	};	117	};
119		118
120	//	119	//
121	// DEBUGPORT variable definitions...	120	// DEBUGPORT variable definitions...
122	//	121	//
123	#define EFI_DEBUGPORT_VARIABLE_NAME L"DEBUGPORT"	122	#define EFI_DEBUGPORT_VARIABLE_NAME L"DEBUGPORT"
124	#define EFI_DEBUGPORT_VARIABLE_GUID EFI_DEBUGPORT_PROTOCOL_GUID	123	#define EFI_DEBUGPORT_VARIABLE_GUID EFI_DEBUGPORT_PROTOCOL_GUID
125		124
126	extern EFI_GUID gEfiDebugPortVariableGuid;	125	extern EFI_GUID gEfiDebugPortVariableGuid;
127		126
128	//	127	//
129	// DebugPort device path definitions...	128	// DebugPort device path definitions...
130	//	129	//
131	#define DEVICE_PATH_MESSAGING_DEBUGPORT EFI_DEBUGPORT_PROTOCOL_GUID	130	#define DEVICE_PATH_MESSAGING_DEBUGPORT EFI_DEBUGPORT_PROTOCOL_GUID
132		131
133	extern EFI_GUID gEfiDebugPortDevicePathGuid;	132	extern EFI_GUID gEfiDebugPortDevicePathGuid;
134		133
135	typedef struct {	134	typedef struct {
136	EFI_DEVICE_PATH_PROTOCOL Header;	135	EFI_DEVICE_PATH_PROTOCOL Header;
137	EFI_GUID Guid;	136	EFI_GUID Guid;
138	} DEBUGPORT_DEVICE_PATH;	137	} DEBUGPORT_DEVICE_PATH;
139		138
140	#endif	139	#endif

Lines 30-41 Link Here

(-)b/sys/contrib/edk2/Include/Protocol/DevicePathFromText.h (-6 / +5 lines)
30		30
31	**/	31	**/
32	typedef	32	typedef
33	EFI_DEVICE_PATH_PROTOCOL*	33	EFI_DEVICE_PATH_PROTOCOL *
34	(EFIAPI *EFI_DEVICE_PATH_FROM_TEXT_NODE)(	34	(EFIAPI *EFI_DEVICE_PATH_FROM_TEXT_NODE)(
35	IN CONST CHAR16 *TextDeviceNode	35	IN CONST CHAR16 *TextDeviceNode
36	);	36	);
37		37
38
39	/**	38	/**
40	Convert text to the binary representation of a device node.	39	Convert text to the binary representation of a device node.
41		40
Lines 48-54 EFI_DEVICE_PATH_PROTOCOL* Link Here
48		47
49	**/	48	**/
50	typedef	49	typedef
51	EFI_DEVICE_PATH_PROTOCOL*	50	EFI_DEVICE_PATH_PROTOCOL *
52	(EFIAPI *EFI_DEVICE_PATH_FROM_TEXT_PATH)(	51	(EFIAPI *EFI_DEVICE_PATH_FROM_TEXT_PATH)(
53	IN CONST CHAR16 *TextDevicePath	52	IN CONST CHAR16 *TextDevicePath
54	);	53	);
Lines 57-66 EFI_DEVICE_PATH_PROTOCOL* Link Here
57	/// This protocol converts text to device paths and device nodes.	56	/// This protocol converts text to device paths and device nodes.
58	///	57	///
59	typedef struct {	58	typedef struct {
60	EFI_DEVICE_PATH_FROM_TEXT_NODE ConvertTextToDeviceNode;	59	EFI_DEVICE_PATH_FROM_TEXT_NODE ConvertTextToDeviceNode;
61	EFI_DEVICE_PATH_FROM_TEXT_PATH ConvertTextToDevicePath;	60	EFI_DEVICE_PATH_FROM_TEXT_PATH ConvertTextToDevicePath;
62	} EFI_DEVICE_PATH_FROM_TEXT_PROTOCOL;	61	} EFI_DEVICE_PATH_FROM_TEXT_PROTOCOL;
63		62
64	extern EFI_GUID gEfiDevicePathFromTextProtocolGuid;	63	extern EFI_GUID gEfiDevicePathFromTextProtocolGuid;
65		64
66	#endif	65	#endif

Lines 17-40 Link Here

(-)b/sys/contrib/edk2/Include/Protocol/SimpleTextIn.h (-9 / +10 lines)
17	0x387477c1, 0x69c7, 0x11d2, {0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \	17	0x387477c1, 0x69c7, 0x11d2, {0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \
18	}	18	}
19		19
20	typedef struct _EFI_SIMPLE_TEXT_INPUT_PROTOCOL EFI_SIMPLE_TEXT_INPUT_PROTOCOL;	20	typedef struct _EFI_SIMPLE_TEXT_INPUT_PROTOCOL EFI_SIMPLE_TEXT_INPUT_PROTOCOL;
21		21
22	///	22	///
23	/// Protocol GUID name defined in EFI1.1.	23	/// Protocol GUID name defined in EFI1.1.
24	///	24	///
25	#define SIMPLE_INPUT_PROTOCOL EFI_SIMPLE_TEXT_INPUT_PROTOCOL_GUID	25	#define SIMPLE_INPUT_PROTOCOL EFI_SIMPLE_TEXT_INPUT_PROTOCOL_GUID
26		26
27	///	27	///
28	/// Protocol name in EFI1.1 for backward-compatible.	28	/// Protocol name in EFI1.1 for backward-compatible.
29	///	29	///
30	typedef struct _EFI_SIMPLE_TEXT_INPUT_PROTOCOL SIMPLE_INPUT_INTERFACE;	30	typedef struct _EFI_SIMPLE_TEXT_INPUT_PROTOCOL SIMPLE_INPUT_INTERFACE;
31		31
32	///	32	///
33	/// The keystroke information for the key that was pressed.	33	/// The keystroke information for the key that was pressed.
34	///	34	///
35	typedef struct {	35	typedef struct {
36	UINT16 ScanCode;	36	UINT16 ScanCode;
37	CHAR16 UnicodeChar;	37	CHAR16 UnicodeChar;
38	} EFI_INPUT_KEY;	38	} EFI_INPUT_KEY;
39		39
40	//	40	//
Lines 100-105 EFI_STATUS Link Here
100	@retval EFI_NOT_READY There was no keystroke data available.	100	@retval EFI_NOT_READY There was no keystroke data available.
101	@retval EFI_DEVICE_ERROR The keystroke information was not returned due to	101	@retval EFI_DEVICE_ERROR The keystroke information was not returned due to
102	hardware errors.	102	hardware errors.
		103	@retval EFI_UNSUPPORTED The device does not support the ability to read keystroke data.
103		104
104	**/	105	**/
105	typedef	106	typedef
Lines 114-127 EFI_STATUS Link Here
114	/// It is the minimum required protocol for ConsoleIn.	115	/// It is the minimum required protocol for ConsoleIn.
115	///	116	///
116	struct _EFI_SIMPLE_TEXT_INPUT_PROTOCOL {	117	struct _EFI_SIMPLE_TEXT_INPUT_PROTOCOL {
117	EFI_INPUT_RESET Reset;	118	EFI_INPUT_RESET Reset;
118	EFI_INPUT_READ_KEY ReadKeyStroke;	119	EFI_INPUT_READ_KEY ReadKeyStroke;
119	///	120	///
120	/// Event to use with WaitForEvent() to wait for a key to be available	121	/// Event to use with WaitForEvent() to wait for a key to be available
121	///	122	///
122	EFI_EVENT WaitForKey;	123	EFI_EVENT WaitForKey;
123	};	124	};
124		125
125	extern EFI_GUID gEfiSimpleTextInProtocolGuid;	126	extern EFI_GUID gEfiSimpleTextInProtocolGuid;
126		127
127	#endif	128	#endif

Lines 18-24 Link Here

(-)b/sys/contrib/edk2/Include/Protocol/SimpleTextInEx.h (-64 / +60 lines)
18	#define EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL_GUID \	18	#define EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL_GUID \
19	{0xdd9e7534, 0x7762, 0x4698, { 0x8c, 0x14, 0xf5, 0x85, 0x17, 0xa6, 0x25, 0xaa } }	19	{0xdd9e7534, 0x7762, 0x4698, { 0x8c, 0x14, 0xf5, 0x85, 0x17, 0xa6, 0x25, 0xaa } }
20		20
21
22	typedef struct _EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL;	21	typedef struct _EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL;
23		22
24	/**	23	/**
Lines 51-58 EFI_STATUS Link Here
51	(EFIAPI *EFI_INPUT_RESET_EX)(	50	(EFIAPI *EFI_INPUT_RESET_EX)(
52	IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,	51	IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,
53	IN BOOLEAN ExtendedVerification	52	IN BOOLEAN ExtendedVerification
54	);	53	);
55
56		54
57	///	55	///
58	/// EFI_KEY_TOGGLE_STATE. The toggle states are defined.	56	/// EFI_KEY_TOGGLE_STATE. The toggle states are defined.
Lines 68-92 typedef struct _EFI_KEY_STATE { Link Here
68	/// returned value is valid only if the high	66	/// returned value is valid only if the high
69	/// order bit has been set.	67	/// order bit has been set.
70	///	68	///
71	UINT32 KeyShiftState;	69	UINT32 KeyShiftState;
72	///	70	///
73	/// Reflects the current internal state of	71	/// Reflects the current internal state of
74	/// various toggled attributes. The returned	72	/// various toggled attributes. The returned
75	/// value is valid only if the high order	73	/// value is valid only if the high order
76	/// bit has been set.	74	/// bit has been set.
77	///	75	///
78	EFI_KEY_TOGGLE_STATE KeyToggleState;	76	EFI_KEY_TOGGLE_STATE KeyToggleState;
79	} EFI_KEY_STATE;	77	} EFI_KEY_STATE;
80		78
81	typedef struct {	79	typedef struct {
82	///	80	///
83	/// The EFI scan code and Unicode value returned from the input device.	81	/// The EFI scan code and Unicode value returned from the input device.
84	///	82	///
85	EFI_INPUT_KEY Key;	83	EFI_INPUT_KEY Key;
86	///	84	///
87	/// The current state of various toggled attributes as well as input modifier values.	85	/// The current state of various toggled attributes as well as input modifier values.
88	///	86	///
89	EFI_KEY_STATE KeyState;	87	EFI_KEY_STATE KeyState;
90	} EFI_KEY_DATA;	88	} EFI_KEY_DATA;
91		89
92	//	90	//
Lines 95-149 typedef struct { Link Here
95	//	93	//
96	// Shift state	94	// Shift state
97	//	95	//
98	#define EFI_SHIFT_STATE_VALID 0x80000000	96	#define EFI_SHIFT_STATE_VALID 0x80000000
99	#define EFI_RIGHT_SHIFT_PRESSED 0x00000001	97	#define EFI_RIGHT_SHIFT_PRESSED 0x00000001
100	#define EFI_LEFT_SHIFT_PRESSED 0x00000002	98	#define EFI_LEFT_SHIFT_PRESSED 0x00000002
101	#define EFI_RIGHT_CONTROL_PRESSED 0x00000004	99	#define EFI_RIGHT_CONTROL_PRESSED 0x00000004
102	#define EFI_LEFT_CONTROL_PRESSED 0x00000008	100	#define EFI_LEFT_CONTROL_PRESSED 0x00000008
103	#define EFI_RIGHT_ALT_PRESSED 0x00000010	101	#define EFI_RIGHT_ALT_PRESSED 0x00000010
104	#define EFI_LEFT_ALT_PRESSED 0x00000020	102	#define EFI_LEFT_ALT_PRESSED 0x00000020
105	#define EFI_RIGHT_LOGO_PRESSED 0x00000040	103	#define EFI_RIGHT_LOGO_PRESSED 0x00000040
106	#define EFI_LEFT_LOGO_PRESSED 0x00000080	104	#define EFI_LEFT_LOGO_PRESSED 0x00000080
107	#define EFI_MENU_KEY_PRESSED 0x00000100	105	#define EFI_MENU_KEY_PRESSED 0x00000100
108	#define EFI_SYS_REQ_PRESSED 0x00000200	106	#define EFI_SYS_REQ_PRESSED 0x00000200
109		107
110	//	108	//
111	// Toggle state	109	// Toggle state
112	//	110	//
113	#define EFI_TOGGLE_STATE_VALID 0x80	111	#define EFI_TOGGLE_STATE_VALID 0x80
114	#define EFI_KEY_STATE_EXPOSED 0x40	112	#define EFI_KEY_STATE_EXPOSED 0x40
115	#define EFI_SCROLL_LOCK_ACTIVE 0x01	113	#define EFI_SCROLL_LOCK_ACTIVE 0x01
116	#define EFI_NUM_LOCK_ACTIVE 0x02	114	#define EFI_NUM_LOCK_ACTIVE 0x02
117	#define EFI_CAPS_LOCK_ACTIVE 0x04	115	#define EFI_CAPS_LOCK_ACTIVE 0x04
118		116
119	//	117	//
120	// EFI Scan codes	118	// EFI Scan codes
121	//	119	//
122	#define SCAN_F11 0x0015	120	#define SCAN_F11 0x0015
123	#define SCAN_F12 0x0016	121	#define SCAN_F12 0x0016
124	#define SCAN_PAUSE 0x0048	122	#define SCAN_PAUSE 0x0048
125	#define SCAN_F13 0x0068	123	#define SCAN_F13 0x0068
126	#define SCAN_F14 0x0069	124	#define SCAN_F14 0x0069
127	#define SCAN_F15 0x006A	125	#define SCAN_F15 0x006A
128	#define SCAN_F16 0x006B	126	#define SCAN_F16 0x006B
129	#define SCAN_F17 0x006C	127	#define SCAN_F17 0x006C
130	#define SCAN_F18 0x006D	128	#define SCAN_F18 0x006D
131	#define SCAN_F19 0x006E	129	#define SCAN_F19 0x006E
132	#define SCAN_F20 0x006F	130	#define SCAN_F20 0x006F
133	#define SCAN_F21 0x0070	131	#define SCAN_F21 0x0070
134	#define SCAN_F22 0x0071	132	#define SCAN_F22 0x0071
135	#define SCAN_F23 0x0072	133	#define SCAN_F23 0x0072
136	#define SCAN_F24 0x0073	134	#define SCAN_F24 0x0073
137	#define SCAN_MUTE 0x007F	135	#define SCAN_MUTE 0x007F
138	#define SCAN_VOLUME_UP 0x0080	136	#define SCAN_VOLUME_UP 0x0080
139	#define SCAN_VOLUME_DOWN 0x0081	137	#define SCAN_VOLUME_DOWN 0x0081
140	#define SCAN_BRIGHTNESS_UP 0x0100	138	#define SCAN_BRIGHTNESS_UP 0x0100
141	#define SCAN_BRIGHTNESS_DOWN 0x0101	139	#define SCAN_BRIGHTNESS_DOWN 0x0101
142	#define SCAN_SUSPEND 0x0102	140	#define SCAN_SUSPEND 0x0102
143	#define SCAN_HIBERNATE 0x0103	141	#define SCAN_HIBERNATE 0x0103
144	#define SCAN_TOGGLE_DISPLAY 0x0104	142	#define SCAN_TOGGLE_DISPLAY 0x0104
145	#define SCAN_RECOVERY 0x0105	143	#define SCAN_RECOVERY 0x0105
146	#define SCAN_EJECT 0x0106	144	#define SCAN_EJECT 0x0106
147		145
148	/**	146	/**
149	The function reads the next keystroke from the input device. If	147	The function reads the next keystroke from the input device. If
Lines 188-193 typedef struct { Link Here
188	@retval EFI_NOT_READY There was no keystroke data available.	186	@retval EFI_NOT_READY There was no keystroke data available.
189	@retval EFI_DEVICE_ERROR The keystroke information was not returned due to	187	@retval EFI_DEVICE_ERROR The keystroke information was not returned due to
190	hardware errors.	188	hardware errors.
		189	@retval EFI_UNSUPPORTED The device does not support the ability to read keystroke data.
191		190
192		191
193	**/	192	**/
Lines 196-202 EFI_STATUS Link Here
196	(EFIAPI *EFI_INPUT_READ_KEY_EX)(	195	(EFIAPI *EFI_INPUT_READ_KEY_EX)(
197	IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,	196	IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,
198	OUT EFI_KEY_DATA *KeyData	197	OUT EFI_KEY_DATA *KeyData
199	);	198	);
200		199
201	/**	200	/**
202	The SetState() function allows the input device hardware to	201	The SetState() function allows the input device hardware to
Lines 223-229 EFI_STATUS Link Here
223	(EFIAPI *EFI_SET_STATE)(	222	(EFIAPI *EFI_SET_STATE)(
224	IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,	223	IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,
225	IN EFI_KEY_TOGGLE_STATE *KeyToggleState	224	IN EFI_KEY_TOGGLE_STATE *KeyToggleState
226	);	225	);
227		226
228	///	227	///
229	/// The function will be called when the key sequence is typed specified by KeyData.	228	/// The function will be called when the key sequence is typed specified by KeyData.
Lines 232-238 typedef Link Here
232	EFI_STATUS	231	EFI_STATUS
233	(EFIAPI *EFI_KEY_NOTIFY_FUNCTION)(	232	(EFIAPI *EFI_KEY_NOTIFY_FUNCTION)(
234	IN EFI_KEY_DATA *KeyData	233	IN EFI_KEY_DATA *KeyData
235	);	234	);
236		235
237	/**	236	/**
238	The RegisterKeystrokeNotify() function registers a function	237	The RegisterKeystrokeNotify() function registers a function
Lines 267-273 EFI_STATUS Link Here
267	IN EFI_KEY_DATA *KeyData,	266	IN EFI_KEY_DATA *KeyData,
268	IN EFI_KEY_NOTIFY_FUNCTION KeyNotificationFunction,	267	IN EFI_KEY_NOTIFY_FUNCTION KeyNotificationFunction,
269	OUT VOID **NotifyHandle	268	OUT VOID **NotifyHandle
270	);	269	);
271		270
272	/**	271	/**
273	The UnregisterKeystrokeNotify() function removes the	272	The UnregisterKeystrokeNotify() function removes the
Lines 289-296 EFI_STATUS Link Here
289	(EFIAPI *EFI_UNREGISTER_KEYSTROKE_NOTIFY)(	288	(EFIAPI *EFI_UNREGISTER_KEYSTROKE_NOTIFY)(
290	IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,	289	IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,
291	IN VOID *NotificationHandle	290	IN VOID *NotificationHandle
292	);	291	);
293
294		292
295	///	293	///
296	/// The EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL is used on the ConsoleIn	294	/// The EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL is used on the ConsoleIn
Lines 298-317 EFI_STATUS Link Here
298	/// which allows a variety of extended shift state information to be	296	/// which allows a variety of extended shift state information to be
299	/// returned.	297	/// returned.
300	///	298	///
301	struct _EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL{	299	struct _EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL {
302	EFI_INPUT_RESET_EX Reset;	300	EFI_INPUT_RESET_EX Reset;
303	EFI_INPUT_READ_KEY_EX ReadKeyStrokeEx;	301	EFI_INPUT_READ_KEY_EX ReadKeyStrokeEx;
304	///	302	///
305	/// Event to use with WaitForEvent() to wait for a key to be available.	303	/// Event to use with WaitForEvent() to wait for a key to be available.
306	///	304	///
307	EFI_EVENT WaitForKeyEx;	305	EFI_EVENT WaitForKeyEx;
308	EFI_SET_STATE SetState;	306	EFI_SET_STATE SetState;
309	EFI_REGISTER_KEYSTROKE_NOTIFY RegisterKeyNotify;	307	EFI_REGISTER_KEYSTROKE_NOTIFY RegisterKeyNotify;
310	EFI_UNREGISTER_KEYSTROKE_NOTIFY UnregisterKeyNotify;	308	EFI_UNREGISTER_KEYSTROKE_NOTIFY UnregisterKeyNotify;
311	};	309	};
312		310
313		311	extern EFI_GUID gEfiSimpleTextInputExProtocolGuid;
314	extern EFI_GUID gEfiSimpleTextInputExProtocolGuid;
315		312
316	#endif	313	#endif
317

Lines 22-38 SPDX-License-Identifier: BSD-2-Clause-Patent Link Here

(-)b/sys/contrib/edk2/Include/Protocol/SimpleTextOut.h (-48 / +48 lines)
22	///	22	///
23	/// Protocol GUID defined in EFI1.1.	23	/// Protocol GUID defined in EFI1.1.
24	///	24	///
25	#define SIMPLE_TEXT_OUTPUT_PROTOCOL EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL_GUID	25	#define SIMPLE_TEXT_OUTPUT_PROTOCOL EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL_GUID
26		26
27	typedef struct _EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL;	27	typedef struct _EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL;
28		28
29	///	29	///
30	/// Backward-compatible with EFI1.1.	30	/// Backward-compatible with EFI1.1.
31	///	31	///
32	typedef EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL SIMPLE_TEXT_OUTPUT_INTERFACE;	32	typedef EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL SIMPLE_TEXT_OUTPUT_INTERFACE;
33		33
34	//	34	//
35	// Define's for required EFI Unicode Box Draw characters	35	// Defines for required EFI Unicode Box Draw characters
36	//	36	//
37	#define BOXDRAW_HORIZONTAL 0x2500	37	#define BOXDRAW_HORIZONTAL 0x2500
38	#define BOXDRAW_VERTICAL 0x2502	38	#define BOXDRAW_VERTICAL 0x2502
Lines 84-122 typedef EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL SIMPLE_TEXT_OUTPUT_INTERFACE; Link Here
84	//	84	//
85	// EFI Required Geometric Shapes Code Chart	85	// EFI Required Geometric Shapes Code Chart
86	//	86	//
87	#define GEOMETRICSHAPE_UP_TRIANGLE 0x25b2	87	#define GEOMETRICSHAPE_UP_TRIANGLE 0x25b2
88	#define GEOMETRICSHAPE_RIGHT_TRIANGLE 0x25ba	88	#define GEOMETRICSHAPE_RIGHT_TRIANGLE 0x25ba
89	#define GEOMETRICSHAPE_DOWN_TRIANGLE 0x25bc	89	#define GEOMETRICSHAPE_DOWN_TRIANGLE 0x25bc
90	#define GEOMETRICSHAPE_LEFT_TRIANGLE 0x25c4	90	#define GEOMETRICSHAPE_LEFT_TRIANGLE 0x25c4
91		91
92	//	92	//
93	// EFI Required Arrow shapes	93	// EFI Required Arrow shapes
94	//	94	//
95	#define ARROW_LEFT 0x2190	95	#define ARROW_LEFT 0x2190
96	#define ARROW_UP 0x2191	96	#define ARROW_UP 0x2191
97	#define ARROW_RIGHT 0x2192	97	#define ARROW_RIGHT 0x2192
98	#define ARROW_DOWN 0x2193	98	#define ARROW_DOWN 0x2193
99		99
100	//	100	//
101	// EFI Console Colours	101	// EFI Console Colours
102	//	102	//
103	#define EFI_BLACK 0x00	103	#define EFI_BLACK 0x00
104	#define EFI_BLUE 0x01	104	#define EFI_BLUE 0x01
105	#define EFI_GREEN 0x02	105	#define EFI_GREEN 0x02
106	#define EFI_CYAN (EFI_BLUE \| EFI_GREEN)	106	#define EFI_CYAN (EFI_BLUE \| EFI_GREEN)
107	#define EFI_RED 0x04	107	#define EFI_RED 0x04
108	#define EFI_MAGENTA (EFI_BLUE \| EFI_RED)	108	#define EFI_MAGENTA (EFI_BLUE \| EFI_RED)
109	#define EFI_BROWN (EFI_GREEN \| EFI_RED)	109	#define EFI_BROWN (EFI_GREEN \| EFI_RED)
110	#define EFI_LIGHTGRAY (EFI_BLUE \| EFI_GREEN \| EFI_RED)	110	#define EFI_LIGHTGRAY (EFI_BLUE \| EFI_GREEN \| EFI_RED)
111	#define EFI_BRIGHT 0x08	111	#define EFI_BRIGHT 0x08
112	#define EFI_DARKGRAY (EFI_BLACK \| EFI_BRIGHT)	112	#define EFI_DARKGRAY (EFI_BLACK \| EFI_BRIGHT)
113	#define EFI_LIGHTBLUE (EFI_BLUE \| EFI_BRIGHT)	113	#define EFI_LIGHTBLUE (EFI_BLUE \| EFI_BRIGHT)
114	#define EFI_LIGHTGREEN (EFI_GREEN \| EFI_BRIGHT)	114	#define EFI_LIGHTGREEN (EFI_GREEN \| EFI_BRIGHT)
115	#define EFI_LIGHTCYAN (EFI_CYAN \| EFI_BRIGHT)	115	#define EFI_LIGHTCYAN (EFI_CYAN \| EFI_BRIGHT)
116	#define EFI_LIGHTRED (EFI_RED \| EFI_BRIGHT)	116	#define EFI_LIGHTRED (EFI_RED \| EFI_BRIGHT)
117	#define EFI_LIGHTMAGENTA (EFI_MAGENTA \| EFI_BRIGHT)	117	#define EFI_LIGHTMAGENTA (EFI_MAGENTA \| EFI_BRIGHT)
118	#define EFI_YELLOW (EFI_BROWN \| EFI_BRIGHT)	118	#define EFI_YELLOW (EFI_BROWN \| EFI_BRIGHT)
119	#define EFI_WHITE (EFI_BLUE \| EFI_GREEN \| EFI_RED \| EFI_BRIGHT)	119	#define EFI_WHITE (EFI_BLUE \| EFI_GREEN \| EFI_RED \| EFI_BRIGHT)
120		120
121	//	121	//
122	// Macro to accept color values in their raw form to create	122	// Macro to accept color values in their raw form to create
Lines 129-135 typedef EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL SIMPLE_TEXT_OUTPUT_INTERFACE; Link Here
129	//	129	//
130	// Do not use EFI_BACKGROUND_xxx values with this macro.	130	// Do not use EFI_BACKGROUND_xxx values with this macro.
131	//	131	//
132	#define EFI_TEXT_ATTR(Foreground,Background) ((Foreground) \| ((Background) << 4))	132	#define EFI_TEXT_ATTR(Foreground, Background) ((Foreground) \| ((Background) << 4))
133		133
134	#define EFI_BACKGROUND_BLACK 0x00	134	#define EFI_BACKGROUND_BLACK 0x00
135	#define EFI_BACKGROUND_BLUE 0x10	135	#define EFI_BACKGROUND_BLUE 0x10
Lines 151-157 typedef EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL SIMPLE_TEXT_OUTPUT_INTERFACE; Link Here
151	#define EFI_WIDE_ATTRIBUTE 0x80	151	#define EFI_WIDE_ATTRIBUTE 0x80
152		152
153	/**	153	/**
154	Reset the text output device hardware and optionaly run diagnostics	154	Reset the text output device hardware and optionally run diagnostics
155		155
156	@param This The protocol instance pointer.	156	@param This The protocol instance pointer.
157	@param ExtendedVerification Driver may perform more exhaustive verification	157	@param ExtendedVerification Driver may perform more exhaustive verification
Lines 350-356 typedef struct { Link Here
350	///	350	///
351	/// The number of modes supported by QueryMode () and SetMode ().	351	/// The number of modes supported by QueryMode () and SetMode ().
352	///	352	///
353	INT32 MaxMode;	353	INT32 MaxMode;
354		354
355	//	355	//
356	// current settings	356	// current settings
Lines 359-381 typedef struct { Link Here
359	///	359	///
360	/// The text mode of the output device(s).	360	/// The text mode of the output device(s).
361	///	361	///
362	INT32 Mode;	362	INT32 Mode;
363	///	363	///
364	/// The current character output attribute.	364	/// The current character output attribute.
365	///	365	///
366	INT32 Attribute;	366	INT32 Attribute;
367	///	367	///
368	/// The cursor's column.	368	/// The cursor's column.
369	///	369	///
370	INT32 CursorColumn;	370	INT32 CursorColumn;
371	///	371	///
372	/// The cursor's row.	372	/// The cursor's row.
373	///	373	///
374	INT32 CursorRow;	374	INT32 CursorRow;
375	///	375	///
376	/// The cursor is currently visbile or not.	376	/// The cursor is currently visible or not.
377	///	377	///
378	BOOLEAN CursorVisible;	378	BOOLEAN CursorVisible;
379	} EFI_SIMPLE_TEXT_OUTPUT_MODE;	379	} EFI_SIMPLE_TEXT_OUTPUT_MODE;
380		380
381	///	381	///
Lines 385-409 typedef struct { Link Here
385	/// devices is at least 80 x 25 characters.	385	/// devices is at least 80 x 25 characters.
386	///	386	///
387	struct _EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL {	387	struct _EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL {
388	EFI_TEXT_RESET Reset;	388	EFI_TEXT_RESET Reset;
389		389
390	EFI_TEXT_STRING OutputString;	390	EFI_TEXT_STRING OutputString;
391	EFI_TEXT_TEST_STRING TestString;	391	EFI_TEXT_TEST_STRING TestString;
392		392
393	EFI_TEXT_QUERY_MODE QueryMode;	393	EFI_TEXT_QUERY_MODE QueryMode;
394	EFI_TEXT_SET_MODE SetMode;	394	EFI_TEXT_SET_MODE SetMode;
395	EFI_TEXT_SET_ATTRIBUTE SetAttribute;	395	EFI_TEXT_SET_ATTRIBUTE SetAttribute;
396		396
397	EFI_TEXT_CLEAR_SCREEN ClearScreen;	397	EFI_TEXT_CLEAR_SCREEN ClearScreen;
398	EFI_TEXT_SET_CURSOR_POSITION SetCursorPosition;	398	EFI_TEXT_SET_CURSOR_POSITION SetCursorPosition;
399	EFI_TEXT_ENABLE_CURSOR EnableCursor;	399	EFI_TEXT_ENABLE_CURSOR EnableCursor;
400		400
401	///	401	///
402	/// Pointer to SIMPLE_TEXT_OUTPUT_MODE data.	402	/// Pointer to SIMPLE_TEXT_OUTPUT_MODE data.
403	///	403	///
404	EFI_SIMPLE_TEXT_OUTPUT_MODE *Mode;	404	EFI_SIMPLE_TEXT_OUTPUT_MODE *Mode;
405	};	405	};
406		406
407	extern EFI_GUID gEfiSimpleTextOutProtocolGuid;	407	extern EFI_GUID gEfiSimpleTextOutProtocolGuid;
408		408
409	#endif	409	#endif

Lines 1-9 Link Here

(-)b/sys/contrib/edk2/Include/Uefi/UefiBaseType.h (-59 / +86 lines)
1	/** @file	1	/** @file
2	Defines data types and constants introduced in UEFI.	2	Defines data types and constants introduced in UEFI.
3		3
4	Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>	4	Copyright (c) 2006 - 2021, Intel Corporation. All rights reserved.<BR>
5	Portions copyright (c) 2011 - 2016, ARM Ltd. All rights reserved.<BR>	5	Portions copyright (c) 2011 - 2016, ARM Ltd. All rights reserved.<BR>
6	Copyright (c) 2020, Hewlett Packard Enterprise Development LP. All rights reserved.<BR>	6	Copyright (c) 2020, Hewlett Packard Enterprise Development LP. All rights reserved.<BR>
		7	Copyright (c) 2022, Loongson Technology Corporation Limited. All rights reserved.<BR>
7		8
8	SPDX-License-Identifier: BSD-2-Clause-Patent	9	SPDX-License-Identifier: BSD-2-Clause-Patent
9		10
Lines 21-57 SPDX-License-Identifier: BSD-2-Clause-Patent Link Here
21	///	22	///
22	/// 128-bit buffer containing a unique identifier value.	23	/// 128-bit buffer containing a unique identifier value.
23	///	24	///
24	typedef GUID EFI_GUID;	25	typedef GUID EFI_GUID;
25	///	26	///
26	/// Function return status for EFI API.	27	/// Function return status for EFI API.
27	///	28	///
28	typedef RETURN_STATUS EFI_STATUS;	29	typedef RETURN_STATUS EFI_STATUS;
29	///	30	///
30	/// A collection of related interfaces.	31	/// A collection of related interfaces.
31	///	32	///
32	typedef VOID *EFI_HANDLE;	33	typedef VOID *EFI_HANDLE;
33	///	34	///
34	/// Handle to an event structure.	35	/// Handle to an event structure.
35	///	36	///
36	typedef VOID *EFI_EVENT;	37	typedef VOID *EFI_EVENT;
37	///	38	///
38	/// Task priority level.	39	/// Task priority level.
39	///	40	///
40	typedef UINTN EFI_TPL;	41	typedef UINTN EFI_TPL;
41	///	42	///
42	/// Logical block address.	43	/// Logical block address.
43	///	44	///
44	typedef UINT64 EFI_LBA;	45	typedef UINT64 EFI_LBA;
45		46
46	///	47	///
47	/// 64-bit physical memory address.	48	/// 64-bit physical memory address.
48	///	49	///
49	typedef UINT64 EFI_PHYSICAL_ADDRESS;	50	typedef UINT64 EFI_PHYSICAL_ADDRESS;
50		51
51	///	52	///
52	/// 64-bit virtual memory address.	53	/// 64-bit virtual memory address.
53	///	54	///
54	typedef UINT64 EFI_VIRTUAL_ADDRESS;	55	typedef UINT64 EFI_VIRTUAL_ADDRESS;
55		56
56	///	57	///
57	/// EFI Time Abstraction:	58	/// EFI Time Abstraction:
Lines 65-84 typedef UINT64 EFI_VIRTUAL_ADDRESS; Link Here
65	/// TimeZone: -1440 to 1440 or 2047	66	/// TimeZone: -1440 to 1440 or 2047
66	///	67	///
67	typedef struct {	68	typedef struct {
68	UINT16 Year;	69	UINT16 Year;
69	UINT8 Month;	70	UINT8 Month;
70	UINT8 Day;	71	UINT8 Day;
71	UINT8 Hour;	72	UINT8 Hour;
72	UINT8 Minute;	73	UINT8 Minute;
73	UINT8 Second;	74	UINT8 Second;
74	UINT8 Pad1;	75	UINT8 Pad1;
75	UINT32 Nanosecond;	76	UINT32 Nanosecond;
76	INT16 TimeZone;	77	INT16 TimeZone;
77	UINT8 Daylight;	78	UINT8 Daylight;
78	UINT8 Pad2;	79	UINT8 Pad2;
79	} EFI_TIME;	80	} EFI_TIME;
80		81
81
82	///	82	///
83	/// 4-byte buffer. An IPv4 internet protocol address.	83	/// 4-byte buffer. An IPv4 internet protocol address.
84	///	84	///
Lines 93-99 typedef IPv6_ADDRESS EFI_IPv6_ADDRESS; Link Here
93	/// 32-byte buffer containing a network Media Access Control address.	93	/// 32-byte buffer containing a network Media Access Control address.
94	///	94	///
95	typedef struct {	95	typedef struct {
96	UINT8 Addr[32];	96	UINT8 Addr[32];
97	} EFI_MAC_ADDRESS;	97	} EFI_MAC_ADDRESS;
98		98
99	///	99	///
Lines 101-112 typedef struct { Link Here
101	/// An IPv4 or IPv6 internet protocol address.	101	/// An IPv4 or IPv6 internet protocol address.
102	///	102	///
103	typedef union {	103	typedef union {
104	UINT32 Addr[4];	104	UINT32 Addr[4];
105	EFI_IPv4_ADDRESS v4;	105	EFI_IPv4_ADDRESS v4;
106	EFI_IPv6_ADDRESS v6;	106	EFI_IPv6_ADDRESS v6;
107	} EFI_IP_ADDRESS;	107	} EFI_IP_ADDRESS;
108		108
109
110	///	109	///
111	/// Enumeration of EFI_STATUS.	110	/// Enumeration of EFI_STATUS.
112	///@{	111	///@{
Lines 142-163 typedef union { Link Here
142	#define EFI_END_OF_FILE RETURN_END_OF_FILE	141	#define EFI_END_OF_FILE RETURN_END_OF_FILE
143	#define EFI_INVALID_LANGUAGE RETURN_INVALID_LANGUAGE	142	#define EFI_INVALID_LANGUAGE RETURN_INVALID_LANGUAGE
144	#define EFI_COMPROMISED_DATA RETURN_COMPROMISED_DATA	143	#define EFI_COMPROMISED_DATA RETURN_COMPROMISED_DATA
		144	#define EFI_IP_ADDRESS_CONFLICT RETURN_IP_ADDRESS_CONFLICT
145	#define EFI_HTTP_ERROR RETURN_HTTP_ERROR	145	#define EFI_HTTP_ERROR RETURN_HTTP_ERROR
146		146
147	#define EFI_WARN_UNKNOWN_GLYPH RETURN_WARN_UNKNOWN_GLYPH	147	#define EFI_WARN_UNKNOWN_GLYPH RETURN_WARN_UNKNOWN_GLYPH
148	#define EFI_WARN_DELETE_FAILURE RETURN_WARN_DELETE_FAILURE	148	#define EFI_WARN_DELETE_FAILURE RETURN_WARN_DELETE_FAILURE
149	#define EFI_WARN_WRITE_FAILURE RETURN_WARN_WRITE_FAILURE	149	#define EFI_WARN_WRITE_FAILURE RETURN_WARN_WRITE_FAILURE
150	#define EFI_WARN_BUFFER_TOO_SMALL RETURN_WARN_BUFFER_TOO_SMALL	150	#define EFI_WARN_BUFFER_TOO_SMALL RETURN_WARN_BUFFER_TOO_SMALL
151	#define EFI_WARN_STALE_DATA RETURN_WARN_STALE_DATA	151	#define EFI_WARN_STALE_DATA RETURN_WARN_STALE_DATA
152	#define EFI_WARN_FILE_SYSTEM RETURN_WARN_FILE_SYSTEM	152	#define EFI_WARN_FILE_SYSTEM RETURN_WARN_FILE_SYSTEM
		153	#define EFI_WARN_RESET_REQUIRED RETURN_WARN_RESET_REQUIRED
153	///@}	154	///@}
154		155
155	///	156	///
156	/// Define macro to encode the status code.	157	/// Define macro to encode the status code.
157	///	158	///
158	#define EFIERR(_a) ENCODE_ERROR(_a)	159	#define EFIERR(_a) ENCODE_ERROR(_a)
159		160
160	#define EFI_ERROR(A) RETURN_ERROR(A)	161	#define EFI_ERROR(A) RETURN_ERROR(A)
161		162
162	///	163	///
163	/// ICMP error definitions	164	/// ICMP error definitions
Lines 171-179 typedef union { Link Here
171	///	172	///
172	/// Tcp connection status definitions	173	/// Tcp connection status definitions
173	///@{	174	///@{
174	#define EFI_CONNECTION_FIN EFIERR(104)	175	#define EFI_CONNECTION_FIN EFIERR(104)
175	#define EFI_CONNECTION_RESET EFIERR(105)	176	#define EFI_CONNECTION_RESET EFIERR(105)
176	#define EFI_CONNECTION_REFUSED EFIERR(106)	177	#define EFI_CONNECTION_REFUSED EFIERR(106)
177	///@}	178	///@}
178		179
179	//	180	//
Lines 181-189 typedef union { Link Here
181	// 4KB. This should in no way be confused with the page size of the processor.	182	// 4KB. This should in no way be confused with the page size of the processor.
182	// An EFI_PAGE is just the quanta of memory in EFI.	183	// An EFI_PAGE is just the quanta of memory in EFI.
183	//	184	//
184	#define EFI_PAGE_SIZE SIZE_4KB	185	#define EFI_PAGE_SIZE SIZE_4KB
185	#define EFI_PAGE_MASK 0xFFF	186	#define EFI_PAGE_MASK 0xFFF
186	#define EFI_PAGE_SHIFT 12	187	#define EFI_PAGE_SHIFT 12
187		188
188	/**	189	/**
189	Macro that converts a size, in bytes, to a number of EFI_PAGESs.	190	Macro that converts a size, in bytes, to a number of EFI_PAGESs.
Lines 214-235 typedef union { Link Here
214	///	215	///
215	/// PE32+ Machine type for IA32 UEFI images.	216	/// PE32+ Machine type for IA32 UEFI images.
216	///	217	///
217	#define EFI_IMAGE_MACHINE_IA32 0x014C	218	#define EFI_IMAGE_MACHINE_IA32 0x014C
218		219
219	///	220	///
220	/// PE32+ Machine type for IA64 UEFI images.	221	/// PE32+ Machine type for IA64 UEFI images.
221	///	222	///
222	#define EFI_IMAGE_MACHINE_IA64 0x0200	223	#define EFI_IMAGE_MACHINE_IA64 0x0200
223		224
224	///	225	///
225	/// PE32+ Machine type for EBC UEFI images.	226	/// PE32+ Machine type for EBC UEFI images.
226	///	227	///
227	#define EFI_IMAGE_MACHINE_EBC 0x0EBC	228	#define EFI_IMAGE_MACHINE_EBC 0x0EBC
228		229
229	///	230	///
230	/// PE32+ Machine type for X64 UEFI images.	231	/// PE32+ Machine type for X64 UEFI images.
231	///	232	///
232	#define EFI_IMAGE_MACHINE_X64 0x8664	233	#define EFI_IMAGE_MACHINE_X64 0x8664
233		234
234	///	235	///
235	/// PE32+ Machine type for ARM mixed ARM and Thumb/Thumb2 images.	236	/// PE32+ Machine type for ARM mixed ARM and Thumb/Thumb2 images.
Lines 248-298 typedef union { Link Here
248	#define EFI_IMAGE_MACHINE_RISCV64 0x5064	249	#define EFI_IMAGE_MACHINE_RISCV64 0x5064
249	#define EFI_IMAGE_MACHINE_RISCV128 0x5128	250	#define EFI_IMAGE_MACHINE_RISCV128 0x5128
250		251
251	#if defined (MDE_CPU_IA32)	252	///
		253	/// PE32+ Machine type for LoongArch 32/64 images.
		254	///
		255	#define EFI_IMAGE_MACHINE_LOONGARCH32 0x6232
		256	#define EFI_IMAGE_MACHINE_LOONGARCH64 0x6264
		257
		258	#if !defined (EFI_IMAGE_MACHINE_TYPE_VALUE) && !defined (EFI_IMAGE_MACHINE_CROSS_TYPE_VALUE)
		259	#if defined (MDE_CPU_IA32)
252		260
253	#define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \	261	#define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \
254	((Machine) == EFI_IMAGE_MACHINE_IA32)	262	((Machine) == EFI_IMAGE_MACHINE_IA32)
255		263
256	#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_X64)	264	#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_X64)
257		265
258	#elif defined (MDE_CPU_X64)	266	#elif defined (MDE_CPU_X64)
259		267
260	#define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \	268	#define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \
261	((Machine) == EFI_IMAGE_MACHINE_X64)	269	((Machine) == EFI_IMAGE_MACHINE_X64)
262		270
263	#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_IA32)	271	#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_IA32)
264		272
265	#elif defined (MDE_CPU_ARM)	273	#elif defined (MDE_CPU_ARM)
266		274
267	#define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_ARMTHUMB_MIXED)	275	#define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_ARMTHUMB_MIXED)
268		276
269	#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) (FALSE)	277	#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) (FALSE)
270		278
271	#elif defined (MDE_CPU_AARCH64)	279	#elif defined (MDE_CPU_AARCH64)
272		280
273	#define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \	281	#define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \
274	((Machine) == EFI_IMAGE_MACHINE_AARCH64)	282	((Machine) == EFI_IMAGE_MACHINE_AARCH64)
275		283
276	#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) (FALSE)	284	#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) (FALSE)
277		285
278	#elif defined (MDE_CPU_RISCV64)	286	#elif defined (MDE_CPU_RISCV64)
279	#define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \	287	#define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \
280	((Machine) == EFI_IMAGE_MACHINE_RISCV64)	288	((Machine) == EFI_IMAGE_MACHINE_RISCV64)
281		289
282	#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) (FALSE)	290	#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) (FALSE)
		291
		292	#elif defined (MDE_CPU_LOONGARCH64)
		293
		294	#define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \
		295	((Machine) == EFI_IMAGE_MACHINE_LOONGARCH64)
		296
		297	#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) (FALSE)
283		298
284	#elif defined (MDE_CPU_EBC)	299	#elif defined (MDE_CPU_EBC)
285		300
286	///	301	///
287	/// This is just to make sure you can cross compile with the EBC compiler.	302	/// This is just to make sure you can cross compile with the EBC compiler.
288	/// It does not make sense to have a PE loader coded in EBC.	303	/// It does not make sense to have a PE loader coded in EBC.
289	///	304	///
290	#define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_EBC)	305	#define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_EBC)
291		306
292	#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) (FALSE)	307	#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) (FALSE)
293		308
		309	#else
		310	#error Unknown Processor Type
		311	#endif
294	#else	312	#else
295	#error Unknown Processor Type	313	#if defined (EFI_IMAGE_MACHINE_TYPE_VALUE)
		314	#define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_TYPE_VALUE)
		315	#else
		316	#define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) (FALSE)
		317	#endif
		318	#if defined (EFI_IMAGE_MACHINE_CROSS_TYPE_VALUE)
		319	#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_CROSS_TYPE_VALUE)
		320	#else
		321	#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) (FALSE)
		322	#endif
296	#endif	323	#endif
297		324
298	#endif	325	#endif

Lines 13-27 SPDX-License-Identifier: BSD-2-Clause-Patent Link Here

(-)b/sys/contrib/edk2/Include/Uefi/UefiGpt.h (-19 / +17 lines)
13	/// The primary GUID Partition Table Header must be	13	/// The primary GUID Partition Table Header must be
14	/// located in LBA 1 (i.e., the second logical block).	14	/// located in LBA 1 (i.e., the second logical block).
15	///	15	///
16	#define PRIMARY_PART_HEADER_LBA 1	16	#define PRIMARY_PART_HEADER_LBA 1
17	///	17	///
18	/// EFI Partition Table Signature: "EFI PART".	18	/// EFI Partition Table Signature: "EFI PART".
19	///	19	///
20	#define EFI_PTAB_HEADER_ID SIGNATURE_64 ('E','F','I',' ','P','A','R','T')	20	#define EFI_PTAB_HEADER_ID SIGNATURE_64 ('E','F','I',' ','P','A','R','T')
21	///	21	///
22	/// Minimum bytes reserve for EFI entry array buffer.	22	/// Minimum bytes reserve for EFI entry array buffer.
23	///	23	///
24	#define EFI_GPT_PART_ENTRY_MIN_SIZE 16384	24	#define EFI_GPT_PART_ENTRY_MIN_SIZE 16384
25		25
26	#pragma pack(1)	26	#pragma pack(1)
27		27
Lines 33-83 typedef struct { Link Here
33	/// The table header for the GPT partition Table.	33	/// The table header for the GPT partition Table.
34	/// This header contains EFI_PTAB_HEADER_ID.	34	/// This header contains EFI_PTAB_HEADER_ID.
35	///	35	///
36	EFI_TABLE_HEADER Header;	36	EFI_TABLE_HEADER Header;
37	///	37	///
38	/// The LBA that contains this data structure.	38	/// The LBA that contains this data structure.
39	///	39	///
40	EFI_LBA MyLBA;	40	EFI_LBA MyLBA;
41	///	41	///
42	/// LBA address of the alternate GUID Partition Table Header.	42	/// LBA address of the alternate GUID Partition Table Header.
43	///	43	///
44	EFI_LBA AlternateLBA;	44	EFI_LBA AlternateLBA;
45	///	45	///
46	/// The first usable logical block that may be used	46	/// The first usable logical block that may be used
47	/// by a partition described by a GUID Partition Entry.	47	/// by a partition described by a GUID Partition Entry.
48	///	48	///
49	EFI_LBA FirstUsableLBA;	49	EFI_LBA FirstUsableLBA;
50	///	50	///
51	/// The last usable logical block that may be used	51	/// The last usable logical block that may be used
52	/// by a partition described by a GUID Partition Entry.	52	/// by a partition described by a GUID Partition Entry.
53	///	53	///
54	EFI_LBA LastUsableLBA;	54	EFI_LBA LastUsableLBA;
55	///	55	///
56	/// GUID that can be used to uniquely identify the disk.	56	/// GUID that can be used to uniquely identify the disk.
57	///	57	///
58	EFI_GUID DiskGUID;	58	EFI_GUID DiskGUID;
59	///	59	///
60	/// The starting LBA of the GUID Partition Entry array.	60	/// The starting LBA of the GUID Partition Entry array.
61	///	61	///
62	EFI_LBA PartitionEntryLBA;	62	EFI_LBA PartitionEntryLBA;
63	///	63	///
64	/// The number of Partition Entries in the GUID Partition Entry array.	64	/// The number of Partition Entries in the GUID Partition Entry array.
65	///	65	///
66	UINT32 NumberOfPartitionEntries;	66	UINT32 NumberOfPartitionEntries;
67	///	67	///
68	/// The size, in bytes, of each the GUID Partition	68	/// The size, in bytes, of each the GUID Partition
69	/// Entry structures in the GUID Partition Entry	69	/// Entry structures in the GUID Partition Entry
70	/// array. This field shall be set to a value of 128 x 2^n where n is	70	/// array. This field shall be set to a value of 128 x 2^n where n is
71	/// an integer greater than or equal to zero (e.g., 128, 256, 512, etc.).	71	/// an integer greater than or equal to zero (e.g., 128, 256, 512, etc.).
72	///	72	///
73	UINT32 SizeOfPartitionEntry;	73	UINT32 SizeOfPartitionEntry;
74	///	74	///
75	/// The CRC32 of the GUID Partition Entry array.	75	/// The CRC32 of the GUID Partition Entry array.
76	/// Starts at PartitionEntryLBA and is	76	/// Starts at PartitionEntryLBA and is
77	/// computed over a byte length of	77	/// computed over a byte length of
78	/// NumberOfPartitionEntries * SizeOfPartitionEntry.	78	/// NumberOfPartitionEntries * SizeOfPartitionEntry.
79	///	79	///
80	UINT32 PartitionEntryArrayCRC32;	80	UINT32 PartitionEntryArrayCRC32;
81	} EFI_PARTITION_TABLE_HEADER;	81	} EFI_PARTITION_TABLE_HEADER;
82		82
83	///	83	///
Lines 88-108 typedef struct { Link Here
88	/// Unique ID that defines the purpose and type of this Partition. A value of	88	/// Unique ID that defines the purpose and type of this Partition. A value of
89	/// zero defines that this partition entry is not being used.	89	/// zero defines that this partition entry is not being used.
90	///	90	///
91	EFI_GUID PartitionTypeGUID;	91	EFI_GUID PartitionTypeGUID;
92	///	92	///
93	/// GUID that is unique for every partition entry. Every partition ever	93	/// GUID that is unique for every partition entry. Every partition ever
94	/// created will have a unique GUID.	94	/// created will have a unique GUID.
95	/// This GUID must be assigned when the GUID Partition Entry is created.	95	/// This GUID must be assigned when the GUID Partition Entry is created.
96	///	96	///
97	EFI_GUID UniquePartitionGUID;	97	EFI_GUID UniquePartitionGUID;
98	///	98	///
99	/// Starting LBA of the partition defined by this entry	99	/// Starting LBA of the partition defined by this entry
100	///	100	///
101	EFI_LBA StartingLBA;	101	EFI_LBA StartingLBA;
102	///	102	///
103	/// Ending LBA of the partition defined by this entry.	103	/// Ending LBA of the partition defined by this entry.
104	///	104	///
105	EFI_LBA EndingLBA;	105	EFI_LBA EndingLBA;
106	///	106	///
107	/// Attribute bits, all bits reserved by UEFI	107	/// Attribute bits, all bits reserved by UEFI
108	/// Bit 0: If this bit is set, the partition is required for the platform to function. The owner/creator of the	108	/// Bit 0: If this bit is set, the partition is required for the platform to function. The owner/creator of the
Lines 135-139 typedef struct { Link Here
135		135
136	#pragma pack()	136	#pragma pack()
137	#endif	137	#endif
138
139

Lines 12-37 SPDX-License-Identifier: BSD-2-Clause-Patent Link Here

(-)b/sys/contrib/edk2/Include/Uefi/UefiMultiPhase.h (-18 / +23 lines)
12	///	12	///
13	/// Attributes of variable.	13	/// Attributes of variable.
14	///	14	///
15	#define EFI_VARIABLE_NON_VOLATILE 0x00000001	15	#define EFI_VARIABLE_NON_VOLATILE 0x00000001
16	#define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x00000002	16	#define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x00000002
17	#define EFI_VARIABLE_RUNTIME_ACCESS 0x00000004	17	#define EFI_VARIABLE_RUNTIME_ACCESS 0x00000004
18	///	18	///
19	/// This attribute is identified by the mnemonic 'HR'	19	/// This attribute is identified by the mnemonic 'HR'
20	/// elsewhere in this specification.	20	/// elsewhere in this specification.
21	///	21	///
22	#define EFI_VARIABLE_HARDWARE_ERROR_RECORD 0x00000008	22	#define EFI_VARIABLE_HARDWARE_ERROR_RECORD 0x00000008
23	///	23	///
24	/// Attributes of Authenticated Variable	24	/// Attributes of Authenticated Variable
25	///	25	///
26	#define EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS 0x00000020	26	#define EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS 0x00000020
27	#define EFI_VARIABLE_APPEND_WRITE 0x00000040	27	#define EFI_VARIABLE_APPEND_WRITE 0x00000040
28	///	28	///
29	/// NOTE: EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS is deprecated and should be considered reserved.	29	/// NOTE: EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS is deprecated and should be considered reserved.
30	///	30	///
31	#define EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS 0x00000010	31	#define EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS 0x00000010
32		32
33	#ifndef VFRCOMPILE	33	#ifndef VFRCOMPILE
34	#include <Guid/WinCertificate.h>	34	#include <Guid/WinCertificate.h>
35	///	35	///
36	/// Enumeration of memory types introduced in UEFI.	36	/// Enumeration of memory types introduced in UEFI.
37	///	37	///
Lines 103-108 typedef enum { Link Here
103	/// however it happens to also support byte-addressable non-volatility.	103	/// however it happens to also support byte-addressable non-volatility.
104	///	104	///
105	EfiPersistentMemory,	105	EfiPersistentMemory,
		106	///
		107	/// A memory region that describes system memory that has not been accepted
		108	/// by a corresponding call to the underlying isolation architecture.
		109	///
		110	EfiUnacceptedMemoryType,
106	EfiMaxMemoryType	111	EfiMaxMemoryType
107	} EFI_MEMORY_TYPE;	112	} EFI_MEMORY_TYPE;
108		113
Lines 148-174 typedef struct { Link Here
148	/// Unique signatures have been generated for the EFI System Table,	153	/// Unique signatures have been generated for the EFI System Table,
149	/// the EFI Boot Services Table, and the EFI Runtime Services Table.	154	/// the EFI Boot Services Table, and the EFI Runtime Services Table.
150	///	155	///
151	UINT64 Signature;	156	UINT64 Signature;
152	///	157	///
153	/// The revision of the EFI Specification to which this table	158	/// The revision of the EFI Specification to which this table
154	/// conforms. The upper 16 bits of this field contain the major	159	/// conforms. The upper 16 bits of this field contain the major
155	/// revision value, and the lower 16 bits contain the minor revision	160	/// revision value, and the lower 16 bits contain the minor revision
156	/// value. The minor revision values are limited to the range of 00..99.	161	/// value. The minor revision values are limited to the range of 00..99.
157	///	162	///
158	UINT32 Revision;	163	UINT32 Revision;
159	///	164	///
160	/// The size, in bytes, of the entire table including the EFI_TABLE_HEADER.	165	/// The size, in bytes, of the entire table including the EFI_TABLE_HEADER.
161	///	166	///
162	UINT32 HeaderSize;	167	UINT32 HeaderSize;
163	///	168	///
164	/// The 32-bit CRC for the entire table. This value is computed by	169	/// The 32-bit CRC for the entire table. This value is computed by
165	/// setting this field to 0, and computing the 32-bit CRC for HeaderSize bytes.	170	/// setting this field to 0, and computing the 32-bit CRC for HeaderSize bytes.
166	///	171	///
167	UINT32 CRC32;	172	UINT32 CRC32;
168	///	173	///
169	/// Reserved field that must be set to 0.	174	/// Reserved field that must be set to 0.
170	///	175	///
171	UINT32 Reserved;	176	UINT32 Reserved;
172	} EFI_TABLE_HEADER;	177	} EFI_TABLE_HEADER;
173		178
174	///	179	///
Lines 193-199 typedef struct { Link Here
193	/// replay. Incremented during each	198	/// replay. Incremented during each
194	/// "Write" access.	199	/// "Write" access.
195	///	200	///
196	UINT64 MonotonicCount;	201	UINT64 MonotonicCount;
197	///	202	///
198	/// Provides the authorization for the variable	203	/// Provides the authorization for the variable
199	/// access. It is a signature across the	204	/// access. It is a signature across the
Lines 202-208 typedef struct { Link Here
202	/// associated with a public key that has been	207	/// associated with a public key that has been
203	/// provisioned via the key exchange.	208	/// provisioned via the key exchange.
204	///	209	///
205	WIN_CERTIFICATE_UEFI_GUID AuthInfo;	210	WIN_CERTIFICATE_UEFI_GUID AuthInfo;
206	} EFI_VARIABLE_AUTHENTICATION;	211	} EFI_VARIABLE_AUTHENTICATION;
207		212
208	///	213	///
Lines 218-229 typedef struct { Link Here
218	/// For the TimeStamp value, components Pad1, Nanosecond, TimeZone, Daylight and	223	/// For the TimeStamp value, components Pad1, Nanosecond, TimeZone, Daylight and
219	/// Pad2 shall be set to 0. This means that the time shall always be expressed in GMT.	224	/// Pad2 shall be set to 0. This means that the time shall always be expressed in GMT.
220	///	225	///
221	EFI_TIME TimeStamp;	226	EFI_TIME TimeStamp;
222	///	227	///
223	/// Only a CertType of EFI_CERT_TYPE_PKCS7_GUID is accepted.	228	/// Only a CertType of EFI_CERT_TYPE_PKCS7_GUID is accepted.
224	///	229	///
225	WIN_CERTIFICATE_UEFI_GUID AuthInfo;	230	WIN_CERTIFICATE_UEFI_GUID AuthInfo;
226	} EFI_VARIABLE_AUTHENTICATION_2;	231	} EFI_VARIABLE_AUTHENTICATION_2;
227	#endif // VFRCOMPILE	232	#endif // VFRCOMPILE
228		233
229	#endif	234	#endif