\r
#include <ProcessorBind.h>\r
\r
+///\r
+/// EFI boot mode\r
+/// \r
typedef UINT32 EFI_BOOT_MODE;\r
\r
//\r
\r
#include <Pi/PiMultiPhase.h>\r
\r
-//\r
-// Global Coherencey Domain types\r
-//\r
+///\r
+/// Global Coherencey Domain types - Memory type\r
+///\r
typedef enum {\r
EfiGcdMemoryTypeNonExistent,\r
EfiGcdMemoryTypeReserved,\r
EfiGcdMemoryTypeMaximum\r
} EFI_GCD_MEMORY_TYPE;\r
\r
-\r
+///\r
+/// Global Coherencey Domain types - IO type\r
+///\r
typedef enum {\r
EfiGcdIoTypeNonExistent,\r
EfiGcdIoTypeReserved,\r
EfiGcdIoTypeMaximum\r
} EFI_GCD_IO_TYPE;\r
\r
-\r
+///\r
+/// The type of allocation to perform.\r
+/// \r
typedef enum {\r
EfiGcdAllocateAnySearchBottomUp,\r
EfiGcdAllocateMaxAddressSearchBottomUp,\r
EfiGcdMaxAllocateType\r
} EFI_GCD_ALLOCATE_TYPE;\r
\r
-\r
+///\r
+/// EFI_GCD_MEMORY_SPACE_DESCRIPTOR\r
+/// \r
typedef struct {\r
+ ///\r
+ /// The physical address of the first byte in the memory region. Type\r
+ /// EFI_PHYSICAL_ADDRESS is defined in the AllocatePages() function\r
+ /// description in the UEFI 2.0 specification\r
+ /// \r
EFI_PHYSICAL_ADDRESS BaseAddress;\r
+\r
+ ///\r
+ /// The number of bytes in the memory region.\r
+ /// \r
UINT64 Length;\r
+\r
+ ///\r
+ /// The bit mask of attributes that the memory region is capable of supporting. The bit\r
+ /// mask of available attributes is defined in the GetMemoryMap() function description\r
+ /// in the UEFI 2.0 specification.\r
+ /// \r
UINT64 Capabilities;\r
+ ///\r
+ /// The bit mask of attributes that the memory region is currently using. The bit mask of\r
+ /// available attributes is defined in GetMemoryMap().\r
+ /// \r
UINT64 Attributes;\r
+ ///\r
+ /// Type of the memory region. Type EFI_GCD_MEMORY_TYPE is defined in the\r
+ /// AddMemorySpace() function description\r
+ /// \r
EFI_GCD_MEMORY_TYPE GcdMemoryType;\r
+\r
+ ///\r
+ /// The image handle of the agent that allocated the memory resource described by\r
+ /// PhysicalStart and NumberOfBytes. If this field is NULL, then the memory\r
+ /// resource is not currently allocated. Type EFI_HANDLE is defined in\r
+ /// InstallProtocolInterface() in the UEFI 2.0 specification.\r
+ /// \r
EFI_HANDLE ImageHandle;\r
+\r
+ ///\r
+ /// The device handle for which the memory resource has been allocated. If\r
+ /// ImageHandle is NULL, then the memory resource is not currently allocated. If this\r
+ /// field is NULL, then the memory resource is not associated with a device that is\r
+ /// described by a device handle. Type EFI_HANDLE is defined in\r
+ /// InstallProtocolInterface() in the UEFI 2.0 specification.\r
+ /// \r
EFI_HANDLE DeviceHandle;\r
} EFI_GCD_MEMORY_SPACE_DESCRIPTOR;\r
\r
-\r
+///\r
+/// EFI_GCD_IO_SPACE_DESCRIPTOR\r
+/// \r
typedef struct {\r
+ ///\r
+ /// Physical address of the first byte in the I/O region. Type\r
+ /// EFI_PHYSICAL_ADDRESS is defined in the AllocatePages() function\r
+ /// description in the UEFI 2.0 specification.\r
+ /// \r
EFI_PHYSICAL_ADDRESS BaseAddress;\r
+\r
+ /// Number of bytes in the I/O region.\r
UINT64 Length;\r
+\r
+ /// \r
+ /// Type of the I/O region. Type EFI_GCD_IO_TYPE is defined in the\r
+ /// AddIoSpace() function description.\r
+ /// \r
EFI_GCD_IO_TYPE GcdIoType;\r
+\r
+ /// \r
+ /// The image handle of the agent that allocated the I/O resource described by\r
+ /// PhysicalStart and NumberOfBytes. If this field is NULL, then the I/O\r
+ /// resource is not currently allocated. Type EFI_HANDLE is defined in\r
+ /// InstallProtocolInterface() in the UEFI 2.0 specification.\r
+ /// \r
EFI_HANDLE ImageHandle;\r
+\r
+ ///\r
+ /// The device handle for which the I/O resource has been allocated. If ImageHandle\r
+ /// is NULL, then the I/O resource is not currently allocated. If this field is NULL, then\r
+ /// the I/O resource is not associated with a device that is described by a device handle.\r
+ /// Type EFI_HANDLE is defined in InstallProtocolInterface() in the UEFI\r
+ /// 2.0 specification.\r
+ /// \r
EFI_HANDLE DeviceHandle;\r
} EFI_GCD_IO_SPACE_DESCRIPTOR;\r
\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_ADD_MEMORY_SPACE) (\r
+(EFIAPI *EFI_ADD_MEMORY_SPACE)(\r
IN EFI_GCD_MEMORY_TYPE GcdMemoryType,\r
IN EFI_PHYSICAL_ADDRESS BaseAddress,\r
IN UINT64 Length,\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_ALLOCATE_MEMORY_SPACE) (\r
+(EFIAPI *EFI_ALLOCATE_MEMORY_SPACE)(\r
IN EFI_GCD_ALLOCATE_TYPE GcdAllocateType,\r
IN EFI_GCD_MEMORY_TYPE GcdMemoryType,\r
IN UINTN Alignment,\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_FREE_MEMORY_SPACE) (\r
+(EFIAPI *EFI_FREE_MEMORY_SPACE)(\r
IN EFI_PHYSICAL_ADDRESS BaseAddress,\r
IN UINT64 Length\r
)\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_REMOVE_MEMORY_SPACE) (\r
+(EFIAPI *EFI_REMOVE_MEMORY_SPACE)(\r
IN EFI_PHYSICAL_ADDRESS BaseAddress,\r
IN UINT64 Length\r
)\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_GET_MEMORY_SPACE_DESCRIPTOR) (\r
+(EFIAPI *EFI_GET_MEMORY_SPACE_DESCRIPTOR)(\r
IN EFI_PHYSICAL_ADDRESS BaseAddress,\r
OUT EFI_GCD_MEMORY_SPACE_DESCRIPTOR *Descriptor\r
)\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_SET_MEMORY_SPACE_ATTRIBUTES) (\r
+(EFIAPI *EFI_SET_MEMORY_SPACE_ATTRIBUTES)(\r
IN EFI_PHYSICAL_ADDRESS BaseAddress,\r
IN UINT64 Length,\r
IN UINT64 Attributes\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_GET_MEMORY_SPACE_MAP) (\r
+(EFIAPI *EFI_GET_MEMORY_SPACE_MAP)(\r
OUT UINTN *NumberOfDescriptors,\r
OUT EFI_GCD_MEMORY_SPACE_DESCRIPTOR **MemorySpaceMap\r
)\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_ADD_IO_SPACE) (\r
+(EFIAPI *EFI_ADD_IO_SPACE)(\r
IN EFI_GCD_IO_TYPE GcdIoType,\r
IN EFI_PHYSICAL_ADDRESS BaseAddress,\r
IN UINT64 Length\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_ALLOCATE_IO_SPACE) (\r
+(EFIAPI *EFI_ALLOCATE_IO_SPACE)(\r
IN EFI_GCD_ALLOCATE_TYPE GcdAllocateType,\r
IN EFI_GCD_IO_TYPE GcdIoType,\r
IN UINTN Alignment,\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_FREE_IO_SPACE) (\r
+(EFIAPI *EFI_FREE_IO_SPACE)(\r
IN EFI_PHYSICAL_ADDRESS BaseAddress,\r
IN UINT64 Length\r
)\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_REMOVE_IO_SPACE) (\r
+(EFIAPI *EFI_REMOVE_IO_SPACE)(\r
IN EFI_PHYSICAL_ADDRESS BaseAddress,\r
IN UINT64 Length\r
)\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_GET_IO_SPACE_DESCRIPTOR) (\r
+(EFIAPI *EFI_GET_IO_SPACE_DESCRIPTOR)(\r
IN EFI_PHYSICAL_ADDRESS BaseAddress,\r
OUT EFI_GCD_IO_SPACE_DESCRIPTOR *Descriptor\r
)\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_GET_IO_SPACE_MAP) (\r
+(EFIAPI *EFI_GET_IO_SPACE_MAP)(\r
OUT UINTN *NumberOfDescriptors,\r
OUT EFI_GCD_IO_SPACE_DESCRIPTOR **IoSpaceMap\r
)\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_DISPATCH) (\r
+(EFIAPI *EFI_DISPATCH)(\r
VOID\r
)\r
;\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_SCHEDULE) (\r
+(EFIAPI *EFI_SCHEDULE)(\r
IN EFI_HANDLE FirmwareVolumeHandle,\r
IN EFI_GUID *DriverName\r
)\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_TRUST) (\r
+(EFIAPI *EFI_TRUST)(\r
IN EFI_HANDLE FirmwareVolumeHandle,\r
IN EFI_GUID *DriverName\r
)\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_PROCESS_FIRMWARE_VOLUME) (\r
+(EFIAPI *EFI_PROCESS_FIRMWARE_VOLUME)(\r
IN VOID *FvHeader,\r
IN UINTN Size,\r
OUT EFI_HANDLE *FirmwareVolumeHandle\r
#include <ProcessorBind.h>\r
\r
#pragma pack(1)\r
-//\r
-// Used to verify the integrity of the file.\r
-// \r
+///\r
+/// Used to verify the integrity of the file.\r
+/// \r
typedef union {\r
struct {\r
UINT8 Header;\r
typedef UINT8 EFI_FFS_FILE_ATTRIBUTES;\r
typedef UINT8 EFI_FFS_FILE_STATE;\r
\r
-//\r
-// File Types Definitions\r
-// \r
+///\r
+/// File Types Definitions\r
+/// \r
#define EFI_FV_FILETYPE_ALL 0x00\r
#define EFI_FV_FILETYPE_RAW 0x01\r
#define EFI_FV_FILETYPE_FREEFORM 0x02\r
#define EFI_FV_FILETYPE_FFS_MIN 0xf0\r
#define EFI_FV_FILETYPE_FFS_MAX 0xff\r
#define EFI_FV_FILETYPE_FFS_PAD 0xf0\r
-// \r
-// FFS File Attributes.\r
-// \r
+/// \r
+/// FFS File Attributes.\r
+/// \r
#define FFS_ATTRIB_FIXED 0x04\r
#define FFS_ATTRIB_DATA_ALIGNMENT 0x38\r
#define FFS_ATTRIB_CHECKSUM 0x40\r
\r
-// \r
-// FFS File State Bits.\r
-// \r
+/// \r
+/// FFS File State Bits.\r
+/// \r
#define EFI_FILE_HEADER_CONSTRUCTION 0x01\r
#define EFI_FILE_HEADER_VALID 0x02\r
#define EFI_FILE_DATA_VALID 0x04\r
#define EFI_FILE_HEADER_INVALID 0x20\r
\r
\r
-//\r
-// Each file begins with the header that describe the \r
-// contents and state of the files.\r
-// \r
+///\r
+/// Each file begins with the header that describe the \r
+/// contents and state of the files.\r
+/// \r
typedef struct {\r
EFI_GUID Name;\r
EFI_FFS_INTEGRITY_CHECK IntegrityCheck;\r
\r
typedef UINT8 EFI_SECTION_TYPE;\r
\r
-//\r
-// Pseudo type. It is\r
-// used as a wild card when retrieving sections. The section\r
-// type EFI_SECTION_ALL matches all section types.\r
-//\r
+///\r
+/// Pseudo type. It is\r
+/// used as a wild card when retrieving sections. The section\r
+/// type EFI_SECTION_ALL matches all section types.\r
+///\r
#define EFI_SECTION_ALL 0x00\r
\r
-//\r
-// Encapsulation section Type values\r
-//\r
+///\r
+/// Encapsulation section Type values\r
+///\r
#define EFI_SECTION_COMPRESSION 0x01\r
\r
#define EFI_SECTION_GUID_DEFINED 0x02\r
\r
-//\r
-// Leaf section Type values\r
-//\r
+///\r
+/// Leaf section Type values\r
+///\r
#define EFI_SECTION_PE32 0x10\r
#define EFI_SECTION_PIC 0x11\r
#define EFI_SECTION_TE 0x12\r
#define EFI_SECTION_RAW 0x19\r
#define EFI_SECTION_PEI_DEPEX 0x1B\r
\r
+///\r
+/// Common section header\r
+/// \r
typedef struct {\r
UINT8 Size[3];\r
EFI_SECTION_TYPE Type;\r
} EFI_COMMON_SECTION_HEADER;\r
\r
-//\r
-// Leaf section type that contains an \r
-// IA-32 16-bit executable image.\r
-// \r
+///\r
+/// Leaf section type that contains an \r
+/// IA-32 16-bit executable image.\r
+/// \r
typedef EFI_COMMON_SECTION_HEADER EFI_COMPATIBILITY16_SECTION;\r
\r
-//\r
-// CompressionType of EFI_COMPRESSION_SECTION.\r
-// \r
+///\r
+/// CompressionType of EFI_COMPRESSION_SECTION.\r
+/// \r
#define EFI_NOT_COMPRESSED 0x00\r
#define EFI_STANDARD_COMPRESSION 0x01\r
-//\r
-// An encapsulation section type in which the \r
-// section data is compressed.\r
-// \r
+///\r
+/// An encapsulation section type in which the \r
+/// section data is compressed.\r
+/// \r
typedef struct {\r
EFI_COMMON_SECTION_HEADER CommonHeader;\r
UINT32 UncompressedLength;\r
UINT8 CompressionType;\r
} EFI_COMPRESSION_SECTION;\r
\r
-//\r
-// Leaf section which could be used to determine the dispatch order of DXEs.\r
-// \r
+///\r
+/// Leaf section which could be used to determine the dispatch order of DXEs.\r
+/// \r
typedef EFI_COMMON_SECTION_HEADER EFI_DXE_DEPEX_SECTION;\r
\r
-//\r
-// Leaf section witch contains a PI FV.\r
-// \r
+///\r
+/// Leaf section witch contains a PI FV.\r
+/// \r
typedef EFI_COMMON_SECTION_HEADER EFI_FIRMWARE_VOLUME_IMAGE_SECTION;\r
\r
-//\r
-// Leaf section which contains a single GUID.\r
-// \r
+///\r
+/// Leaf section which contains a single GUID.\r
+/// \r
typedef struct {\r
EFI_COMMON_SECTION_HEADER CommonHeader;\r
EFI_GUID SubTypeGuid;\r
} EFI_FREEFORM_SUBTYPE_GUID_SECTION;\r
\r
-//\r
-// Attributes of EFI_GUID_DEFINED_SECTION\r
-// \r
+///\r
+/// Attributes of EFI_GUID_DEFINED_SECTION\r
+/// \r
#define EFI_GUIDED_SECTION_PROCESSING_REQUIRED 0x01\r
#define EFI_GUIDED_SECTION_AUTH_STATUS_VALID 0x02\r
-//\r
-// Leaf section which is encapsulation defined by specific GUID\r
-// \r
+///\r
+/// Leaf section which is encapsulation defined by specific GUID\r
+/// \r
typedef struct {\r
EFI_COMMON_SECTION_HEADER CommonHeader;\r
EFI_GUID SectionDefinitionGuid;\r
UINT16 Attributes;\r
} EFI_GUID_DEFINED_SECTION;\r
\r
-//\r
-// Leaf section which contains PE32+ image.\r
-// \r
+///\r
+/// Leaf section which contains PE32+ image.\r
+/// \r
typedef EFI_COMMON_SECTION_HEADER EFI_PE32_SECTION;\r
\r
\r
-//\r
-// Leaf section which used to determine the dispatch order of PEIMs.\r
-// \r
+///\r
+/// Leaf section which used to determine the dispatch order of PEIMs.\r
+/// \r
typedef EFI_COMMON_SECTION_HEADER EFI_PEI_DEPEX_SECTION;\r
\r
-//\r
-// Leaf section which constains the position-independent-code image.\r
-// \r
+///\r
+/// Leaf section which constains the position-independent-code image.\r
+/// \r
typedef EFI_COMMON_SECTION_HEADER EFI_TE_SECTION;\r
\r
-//\r
-// Leaf section which contains an array of zero or more bytes.\r
-// \r
+///\r
+/// Leaf section which contains an array of zero or more bytes.\r
+/// \r
typedef EFI_COMMON_SECTION_HEADER EFI_RAW_SECTION;\r
\r
-//\r
-// Leaf section which contains a unicode string that \r
-// is human readable file name.\r
-// \r
+///\r
+/// Leaf section which contains a unicode string that \r
+/// is human readable file name.\r
+/// \r
typedef struct {\r
EFI_COMMON_SECTION_HEADER CommonHeader;\r
\r
- //\r
- // Array of unicode string.\r
- // \r
+ ///\r
+ /// Array of unicode string.\r
+ /// \r
CHAR16 FileNameString[1];\r
} EFI_USER_INTERFACE_SECTION;\r
\r
\r
-//\r
-// Leaf section which contains a numeric build number and\r
-// an optional unicode string that represent the file revision. \r
-// \r
+///\r
+/// Leaf section which contains a numeric build number and\r
+/// an optional unicode string that represent the file revision. \r
+/// \r
typedef struct {\r
EFI_COMMON_SECTION_HEADER CommonHeader;\r
UINT16 BuildNumber;\r
\r
#include <ProcessorBind.h>\r
\r
-//\r
-// EFI_FV_FILE_ATTRIBUTES\r
-//\r
+///\r
+/// EFI_FV_FILE_ATTRIBUTES\r
+///\r
typedef UINT32 EFI_FV_FILE_ATTRIBUTES;\r
\r
//\r
#define EFI_FV_FILE_ATTRIB_FIXED 0x00000100\r
#define EFI_FV_FILE_ATTRIB_MEMORY_MAPPED 0x00000200\r
\r
+///\r
+/// type of EFI FVB attribute\r
+/// \r
typedef UINT32 EFI_FVB_ATTRIBUTES;\r
\r
// \r
///\r
#define EFI_FVH_REVISION 0x02\r
\r
-//\r
-// Extension header pointed by ExtHeaderOffset of volume header.\r
-// \r
+///\r
+/// Extension header pointed by ExtHeaderOffset of volume header.\r
+/// \r
typedef struct {\r
EFI_GUID FvName;\r
UINT32 ExtHeaderSize;\r
} EFI_FIRMWARE_VOLUME_EXT_HEADER;\r
\r
+///\r
+/// Entry struture for describing FV extension header\r
+/// \r
typedef struct {\r
UINT16 ExtEntrySize;\r
UINT16 ExtEntryType;\r
} EFI_FIRMWARE_VOLUME_EXT_ENTRY;\r
\r
#define EFI_FV_EXT_TYPE_OEM_TYPE 0x01\r
+///\r
+/// This extension header provides a mapping between a GUID and an OEM file type.\r
+/// \r
typedef struct {\r
EFI_FIRMWARE_VOLUME_EXT_ENTRY Hdr;\r
UINT32 TypeMask;\r
#define EFI_HOB_TYPE_UNUSED 0xFFFE\r
#define EFI_HOB_TYPE_END_OF_HOB_LIST 0xFFFF\r
\r
-//\r
-// Describes the format and size of the data inside the HOB. \r
-// All HOBs must contain this generic HOB header.\r
-// \r
+///\r
+/// Describes the format and size of the data inside the HOB. \r
+/// All HOBs must contain this generic HOB header.\r
+/// \r
typedef struct {\r
UINT16 HobType;\r
UINT16 HobLength;\r
} EFI_HOB_GENERIC_HEADER;\r
\r
\r
-//\r
-// Value of version ofinEFI_HOB_HANDOFF_INFO_TABLE.\r
-// \r
+///\r
+/// Value of version ofinEFI_HOB_HANDOFF_INFO_TABLE.\r
+/// \r
#define EFI_HOB_HANDOFF_TABLE_VERSION 0x0009\r
-//\r
-// Contains general state information used by the HOB producer phase. \r
-// This HOB must be the first one in the HOB list.\r
-// \r
+\r
+///\r
+/// Contains general state information used by the HOB producer phase. \r
+/// This HOB must be the first one in the HOB list.\r
+/// \r
typedef struct {\r
EFI_HOB_GENERIC_HEADER Header;\r
UINT32 Version;\r
EFI_PHYSICAL_ADDRESS EfiEndOfHobList;\r
} EFI_HOB_HANDOFF_INFO_TABLE;\r
\r
-\r
+/// EFI_HOB_MEMORY_ALLOCATION_HEADER describes the\r
+/// various attributes of the logical memory allocation. The type field will be used for\r
+/// subsequent inclusion in the UEFI memory map.\r
typedef struct {\r
+ ///\r
+ /// A GUID that defines the memory allocation region¡¯s type and purpose, as well as\r
+ /// other fields within the memory allocation HOB. This GUID is used to define the\r
+ /// additional data within the HOB that may be present for the memory allocation HOB.\r
+ /// Type EFI_GUID is defined in InstallProtocolInterface() in the UEFI 2.0\r
+ /// specification. \r
+ /// \r
EFI_GUID Name;\r
+\r
+ /// The base address of memory allocated by this HOB. Type\r
+ /// EFI_PHYSICAL_ADDRESS is defined in AllocatePages() in the UEFI 2.0\r
+ /// specification.\r
EFI_PHYSICAL_ADDRESS MemoryBaseAddress;\r
+\r
+ /// The length in bytes of memory allocated by this HOB.\r
UINT64 MemoryLength;\r
+\r
+ ///\r
+ /// Defines the type of memory allocated by this HOB. The memory type definition\r
+ /// follows the EFI_MEMORY_TYPE definition. Type EFI_MEMORY_TYPE is defined\r
+ /// in AllocatePages() in the UEFI 2.0 specification.\r
+ /// \r
EFI_MEMORY_TYPE MemoryType;\r
\r
- //\r
- // Padding for Itanium processor family\r
- // \r
+ ///\r
+ /// Padding for Itanium processor family\r
+ ///\r
UINT8 Reserved[4];\r
} EFI_HOB_MEMORY_ALLOCATION_HEADER;\r
\r
-//\r
-// Describes all memory ranges used during the HOB producer \r
-// phase that exist outside the HOB list. This HOB type \r
-// describes how memory is used, \r
-// not the physical attributes of memory.\r
-// \r
+///\r
+/// Describes all memory ranges used during the HOB producer \r
+/// phase that exist outside the HOB list. This HOB type \r
+/// describes how memory is used, \r
+/// not the physical attributes of memory.\r
+/// \r
typedef struct {\r
EFI_HOB_GENERIC_HEADER Header;\r
EFI_HOB_MEMORY_ALLOCATION_HEADER AllocDescriptor;\r
} EFI_HOB_MEMORY_ALLOCATION;\r
\r
\r
-//\r
-// Describes the memory stack that is produced by the HOB producer \r
-// phase and upon which all postmemory-installed executable\r
-// content in the HOB producer phase is executing.\r
-// \r
+///\r
+/// Describes the memory stack that is produced by the HOB producer \r
+/// phase and upon which all postmemory-installed executable\r
+/// content in the HOB producer phase is executing.\r
+/// \r
typedef struct {\r
EFI_HOB_GENERIC_HEADER Header;\r
EFI_HOB_MEMORY_ALLOCATION_HEADER AllocDescriptor;\r
} EFI_HOB_MEMORY_ALLOCATION_STACK;\r
\r
-//\r
-// Defines the location of the boot-strap \r
-// processor (BSP) BSPStore ("Backing Store Pointer Store").\r
-// This HOB is valid for the Itanium processor family only \r
-// register overflow store.\r
-// \r
+///\r
+/// Defines the location of the boot-strap \r
+/// processor (BSP) BSPStore ("Backing Store Pointer Store").\r
+/// This HOB is valid for the Itanium processor family only \r
+/// register overflow store.\r
+/// \r
typedef struct {\r
EFI_HOB_GENERIC_HEADER Header;\r
EFI_HOB_MEMORY_ALLOCATION_HEADER AllocDescriptor;\r
} EFI_HOB_MEMORY_ALLOCATION_BSP_STORE;\r
\r
-//\r
-// Defines the location and entry point of the HOB consumer phase.\r
-// \r
+///\r
+/// Defines the location and entry point of the HOB consumer phase.\r
+///\r
typedef struct {\r
EFI_HOB_GENERIC_HEADER Header;\r
EFI_HOB_MEMORY_ALLOCATION_HEADER MemoryAllocationHeader;\r
EFI_PHYSICAL_ADDRESS EntryPoint;\r
} EFI_HOB_MEMORY_ALLOCATION_MODULE;\r
\r
+///\r
+/// type of Recount type \r
+/// \r
typedef UINT32 EFI_RESOURCE_TYPE;\r
\r
//\r
#define EFI_RESOURCE_IO_RESERVED 0x00000006\r
#define EFI_RESOURCE_MAX_MEMORY_TYPE 0x00000007\r
\r
-\r
+///\r
+/// type of recount attribute type\r
+/// \r
typedef UINT32 EFI_RESOURCE_ATTRIBUTE_TYPE;\r
\r
//\r
#define EFI_RESOURCE_ATTRIBUTE_64_BIT_IO 0x00010000\r
#define EFI_RESOURCE_ATTRIBUTE_UNCACHED_EXPORTED 0x00020000\r
\r
-//\r
-// Describes the resource properties of all fixed, \r
-// nonrelocatable resource ranges found on the processor\r
-// host bus during the HOB producer phase.\r
-// \r
+///\r
+/// Describes the resource properties of all fixed, \r
+/// nonrelocatable resource ranges found on the processor\r
+/// host bus during the HOB producer phase.\r
+/// \r
typedef struct {\r
EFI_HOB_GENERIC_HEADER Header;\r
EFI_GUID Owner;\r
UINT64 ResourceLength;\r
} EFI_HOB_RESOURCE_DESCRIPTOR;\r
\r
-//\r
-// Allows writers of executable content in the HOB producer phase to \r
-// maintain and manage HOBs with specific GUID.\r
-// \r
+///\r
+/// Allows writers of executable content in the HOB producer phase to \r
+/// maintain and manage HOBs with specific GUID.\r
+/// \r
typedef struct {\r
EFI_HOB_GENERIC_HEADER Header;\r
EFI_GUID Name;\r
\r
- //\r
- // Guid specific data goes here\r
- //\r
+ ///\r
+ /// Guid specific data goes here\r
+ ///\r
} EFI_HOB_GUID_TYPE;\r
\r
-//\r
-// Details the location of firmware volumes that contain firmware files.\r
-// \r
+///\r
+/// Details the location of firmware volumes that contain firmware files.\r
+/// \r
typedef struct {\r
EFI_HOB_GENERIC_HEADER Header;\r
EFI_PHYSICAL_ADDRESS BaseAddress;\r
UINT64 Length;\r
} EFI_HOB_FIRMWARE_VOLUME;\r
\r
-//\r
-// Details the location of a firmware volume which was extracted \r
-// from a file within another firmware volume.\r
-// \r
+///\r
+/// Details the location of a firmware volume which was extracted \r
+/// from a file within another firmware volume.\r
+/// \r
typedef struct {\r
EFI_HOB_GENERIC_HEADER Header;\r
EFI_PHYSICAL_ADDRESS BaseAddress;\r
} EFI_HOB_FIRMWARE_VOLUME2;\r
\r
\r
-//\r
-// Describes processor information, such as address space and I/O space capabilities.\r
-// \r
+///\r
+/// Describes processor information, such as address space and I/O space capabilities.\r
+///\r
typedef struct {\r
EFI_HOB_GENERIC_HEADER Header;\r
UINT8 SizeOfMemorySpace;\r
} EFI_HOB_CPU;\r
\r
\r
-//\r
-// Describes pool memory allocations.\r
-// \r
+///\r
+/// Describes pool memory allocations.\r
+/// \r
typedef struct {\r
EFI_HOB_GENERIC_HEADER Header;\r
} EFI_HOB_MEMORY_POOL;\r
\r
-//\r
-// Union of all the possible HOB Types\r
-//\r
+///\r
+/// Union of all the possible HOB Types\r
+///\r
typedef union {\r
EFI_HOB_GENERIC_HEADER *Header;\r
EFI_HOB_HANDOFF_INFO_TABLE *HandoffInformationTable;\r
\r
#define EFI_NOT_AVAILABLE_YET EFIERR (32)\r
\r
-//\r
-// Status Code Type Definition\r
-//\r
+///\r
+/// Status Code Type Definition\r
+///\r
typedef UINT32 EFI_STATUS_CODE_TYPE;\r
\r
//\r
#define EFI_ERROR_UNRECOVERED 0x90000000\r
#define EFI_ERROR_UNCONTAINED 0xa0000000\r
\r
-//\r
-// Status Code Value Definition\r
-//\r
+///\r
+/// Status Code Value Definition\r
+///\r
typedef UINT32 EFI_STATUS_CODE_VALUE;\r
+\r
//\r
// A Status Code Value is made up of the class, subclass, and\r
// an operation.\r
#define EFI_STATUS_CODE_CLASS_MASK 0xFF000000\r
#define EFI_STATUS_CODE_SUBCLASS_MASK 0x00FF0000\r
#define EFI_STATUS_CODE_OPERATION_MASK 0x0000FFFF\r
-//\r
-// Definition of Status Code extended data header.\r
-// The data will follow HeaderSize bytes from the beginning of\r
-// the structure and is Size bytes long.\r
-//\r
+\r
+///\r
+/// Definition of Status Code extended data header.\r
+/// The data will follow HeaderSize bytes from the beginning of\r
+/// the structure and is Size bytes long.\r
+///\r
typedef struct {\r
UINT16 HeaderSize;\r
UINT16 Size;\r
projects / mirror_edk2.git / commitdiff