4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync HOB related definitions in PI.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncCopyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThis program and the accompanying materials are licensed and made available under
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncthe terms and conditions of the BSD License that accompanies this distribution.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThe full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncTHE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncWITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @par Revision Reference:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PI Version 1.0
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// HobType of EFI_HOB_GENERIC_HEADER.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Describes the format and size of the data inside the HOB.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// All HOBs must contain this generic HOB header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Identifies the HOB data structure type.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The length in bytes of the HOB.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// This field must always be set to zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Value of version in EFI_HOB_HANDOFF_INFO_TABLE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Contains general state information used by the HOB producer phase.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// This HOB must be the first one in the HOB list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_HANDOFF.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The version number pertaining to the PHIT HOB definition.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// This value is four bytes in length to provide an 8-byte aligned entry
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// when it is combined with the 4-byte BootMode.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The system boot mode as determined during the HOB producer phase.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The highest address location of memory that is allocated for use by the HOB producer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// phase. This address must be 4-KB aligned to meet page restrictions of UEFI.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The lowest address location of memory that is allocated for use by the HOB producer phase.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The highest address location of free memory that is currently available
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// for use by the HOB producer phase.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The lowest address location of free memory that is available for use by the HOB producer phase.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The end of the HOB list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_HOB_MEMORY_ALLOCATION_HEADER describes the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// various attributes of the logical memory allocation. The type field will be used for
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// subsequent inclusion in the UEFI memory map.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// A GUID that defines the memory allocation region's type and purpose, as well as
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// other fields within the memory allocation HOB. This GUID is used to define the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// additional data within the HOB that may be present for the memory allocation HOB.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Type EFI_GUID is defined in InstallProtocolInterface() in the UEFI 2.0
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// specification.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The base address of memory allocated by this HOB. Type
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// EFI_PHYSICAL_ADDRESS is defined in AllocatePages() in the UEFI 2.0
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// specification.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The length in bytes of memory allocated by this HOB.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Defines the type of memory allocated by this HOB. The memory type definition
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// follows the EFI_MEMORY_TYPE definition. Type EFI_MEMORY_TYPE is defined
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// in AllocatePages() in the UEFI 2.0 specification.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Padding for Itanium processor family
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Describes all memory ranges used during the HOB producer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// phase that exist outside the HOB list. This HOB type
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// describes how memory is used, not the physical attributes of memory.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_MEMORY_ALLOCATION.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// An instance of the EFI_HOB_MEMORY_ALLOCATION_HEADER that describes the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// various attributes of the logical memory allocation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Additional data pertaining to the "Name" Guid memory
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // may go here.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Describes the memory stack that is produced by the HOB producer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// phase and upon which all post-memory-installed executable
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// content in the HOB producer phase is executing.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_MEMORY_ALLOCATION.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// An instance of the EFI_HOB_MEMORY_ALLOCATION_HEADER that describes the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// various attributes of the logical memory allocation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Defines the location of the boot-strap
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// processor (BSP) BSPStore ("Backing Store Pointer Store").
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// This HOB is valid for the Itanium processor family only
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// register overflow store.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_MEMORY_ALLOCATION.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// An instance of the EFI_HOB_MEMORY_ALLOCATION_HEADER that describes the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// various attributes of the logical memory allocation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Defines the location and entry point of the HOB consumer phase.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_MEMORY_ALLOCATION.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// An instance of the EFI_HOB_MEMORY_ALLOCATION_HEADER that describes the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// various attributes of the logical memory allocation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_HOB_MEMORY_ALLOCATION_HEADER MemoryAllocationHeader;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The GUID specifying the values of the firmware file system name
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// that contains the HOB consumer phase component.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The address of the memory-mapped firmware volume
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// that contains the HOB consumer phase firmware file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The resource type.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Value of ResourceType in EFI_HOB_RESOURCE_DESCRIPTOR.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_RESOURCE_MEMORY_MAPPED_IO_PORT 0x00000004
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// A type of recount attribute type.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// These types can be ORed together as needed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// The following attributes are used to describe settings
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_RESOURCE_ATTRIBUTE_INITIALIZED 0x00000002
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_RESOURCE_ATTRIBUTE_READ_PROTECTED 0x00000080
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_RESOURCE_ATTRIBUTE_WRITE_PROTECTED 0x00000100
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_RESOURCE_ATTRIBUTE_EXECUTION_PROTECTED 0x00000200
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// The rest of the attributes are used to describe capabilities
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_RESOURCE_ATTRIBUTE_SINGLE_BIT_ECC 0x00000008
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_RESOURCE_ATTRIBUTE_MULTIPLE_BIT_ECC 0x00000010
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_RESOURCE_ATTRIBUTE_ECC_RESERVED_1 0x00000020
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_RESOURCE_ATTRIBUTE_ECC_RESERVED_2 0x00000040
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_RESOURCE_ATTRIBUTE_UNCACHEABLE 0x00000400
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_RESOURCE_ATTRIBUTE_WRITE_COMBINEABLE 0x00000800
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_RESOURCE_ATTRIBUTE_WRITE_THROUGH_CACHEABLE 0x00001000
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_RESOURCE_ATTRIBUTE_WRITE_BACK_CACHEABLE 0x00002000
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_RESOURCE_ATTRIBUTE_UNCACHED_EXPORTED 0x00020000
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_RESOURCE_ATTRIBUTE_READ_PROTECTABLE 0x00100000
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_RESOURCE_ATTRIBUTE_WRITE_PROTECTABLE 0x00200000
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_RESOURCE_ATTRIBUTE_EXECUTION_PROTECTABLE 0x00400000
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Describes the resource properties of all fixed,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// nonrelocatable resource ranges found on the processor
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// host bus during the HOB producer phase.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_RESOURCE_DESCRIPTOR.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// A GUID representing the owner of the resource. This GUID is used by HOB
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// consumer phase components to correlate device ownership of a resource.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The resource type enumeration as defined by EFI_RESOURCE_TYPE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Resource attributes as defined by EFI_RESOURCE_ATTRIBUTE_TYPE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The physical start address of the resource region.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The number of bytes of the resource region.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Allows writers of executable content in the HOB producer phase to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// maintain and manage HOBs with specific GUID.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_GUID_EXTENSION.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// A GUID that defines the contents of this HOB.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Guid specific data goes here
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Details the location of firmware volumes that contain firmware files.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_FV.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The physical memory-mapped base address of the firmware volume.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The length in bytes of the firmware volume.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Details the location of a firmware volume that was extracted
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// from a file within another firmware volume.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_FV2.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The physical memory-mapped base address of the firmware volume.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The length in bytes of the firmware volume.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The name of the firmware volume.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The name of the firmware file that contained this firmware volume.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Describes processor information, such as address space and I/O space capabilities.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_CPU.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Identifies the maximum physical memory addressability of the processor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Identifies the maximum physical I/O addressability of the processor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// This field will always be set to zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Describes pool memory allocations.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_MEMORY_POOL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Each UEFI capsule HOB details the location of a UEFI capsule. It includes a base address and length
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// which is based upon memory blocks with a EFI_CAPSULE_HEADER and the associated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// CapsuleImageSize-based payloads. These HOB's shall be created by the PEI PI firmware
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// sometime after the UEFI UpdateCapsule service invocation with the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE flag set in the EFI_CAPSULE_HEADER.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The HOB generic header where Header.HobType = EFI_HOB_TYPE_UEFI_CAPSULE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The physical memory-mapped base address of an UEFI capsule. This value is set to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// point to the base of the contiguous memory of the UEFI capsule.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The length of the contiguous memory in bytes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Union of all the possible HOB Types.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef union {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_HOB_HANDOFF_INFO_TABLE *HandoffInformationTable;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_HOB_MEMORY_ALLOCATION_BSP_STORE *MemoryAllocationBspStore;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_HOB_MEMORY_ALLOCATION_STACK *MemoryAllocationStack;