mirror of
https://github.com/CloverHackyColor/CloverBootloader.git
synced 2024-12-10 14:23:31 +01:00
513 lines
17 KiB
C
513 lines
17 KiB
C
/** @file
|
|
HOB related definitions in PI.
|
|
|
|
Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
@par Revision Reference:
|
|
PI Version 1.6
|
|
|
|
**/
|
|
|
|
#ifndef __PI_HOB_H__
|
|
#define __PI_HOB_H__
|
|
|
|
//
|
|
// HobType of EFI_HOB_GENERIC_HEADER.
|
|
//
|
|
#define EFI_HOB_TYPE_HANDOFF 0x0001
|
|
#define EFI_HOB_TYPE_MEMORY_ALLOCATION 0x0002
|
|
#define EFI_HOB_TYPE_RESOURCE_DESCRIPTOR 0x0003
|
|
#define EFI_HOB_TYPE_GUID_EXTENSION 0x0004
|
|
#define EFI_HOB_TYPE_FV 0x0005
|
|
#define EFI_HOB_TYPE_CPU 0x0006
|
|
#define EFI_HOB_TYPE_MEMORY_POOL 0x0007
|
|
#define EFI_HOB_TYPE_FV2 0x0009
|
|
#define EFI_HOB_TYPE_LOAD_PEIM_UNUSED 0x000A
|
|
#define EFI_HOB_TYPE_UEFI_CAPSULE 0x000B
|
|
#define EFI_HOB_TYPE_FV3 0x000C
|
|
#define EFI_HOB_TYPE_UNUSED 0xFFFE
|
|
#define EFI_HOB_TYPE_END_OF_HOB_LIST 0xFFFF
|
|
|
|
///
|
|
/// Describes the format and size of the data inside the HOB.
|
|
/// All HOBs must contain this generic HOB header.
|
|
///
|
|
typedef struct {
|
|
///
|
|
/// Identifies the HOB data structure type.
|
|
///
|
|
UINT16 HobType;
|
|
///
|
|
/// The length in bytes of the HOB.
|
|
///
|
|
UINT16 HobLength;
|
|
///
|
|
/// This field must always be set to zero.
|
|
///
|
|
UINT32 Reserved;
|
|
} EFI_HOB_GENERIC_HEADER;
|
|
|
|
|
|
///
|
|
/// Value of version in EFI_HOB_HANDOFF_INFO_TABLE.
|
|
///
|
|
#define EFI_HOB_HANDOFF_TABLE_VERSION 0x0009
|
|
|
|
///
|
|
/// Contains general state information used by the HOB producer phase.
|
|
/// This HOB must be the first one in the HOB list.
|
|
///
|
|
typedef struct {
|
|
///
|
|
/// The HOB generic header. Header.HobType = EFI_HOB_TYPE_HANDOFF.
|
|
///
|
|
EFI_HOB_GENERIC_HEADER Header;
|
|
///
|
|
/// The version number pertaining to the PHIT HOB definition.
|
|
/// This value is four bytes in length to provide an 8-byte aligned entry
|
|
/// when it is combined with the 4-byte BootMode.
|
|
///
|
|
UINT32 Version;
|
|
///
|
|
/// The system boot mode as determined during the HOB producer phase.
|
|
///
|
|
EFI_BOOT_MODE BootMode;
|
|
///
|
|
/// The highest address location of memory that is allocated for use by the HOB producer
|
|
/// phase. This address must be 4-KB aligned to meet page restrictions of UEFI.
|
|
///
|
|
EFI_PHYSICAL_ADDRESS EfiMemoryTop;
|
|
///
|
|
/// The lowest address location of memory that is allocated for use by the HOB producer phase.
|
|
///
|
|
EFI_PHYSICAL_ADDRESS EfiMemoryBottom;
|
|
///
|
|
/// The highest address location of free memory that is currently available
|
|
/// for use by the HOB producer phase.
|
|
///
|
|
EFI_PHYSICAL_ADDRESS EfiFreeMemoryTop;
|
|
///
|
|
/// The lowest address location of free memory that is available for use by the HOB producer phase.
|
|
///
|
|
EFI_PHYSICAL_ADDRESS EfiFreeMemoryBottom;
|
|
///
|
|
/// The end of the HOB list.
|
|
///
|
|
EFI_PHYSICAL_ADDRESS EfiEndOfHobList;
|
|
} EFI_HOB_HANDOFF_INFO_TABLE;
|
|
|
|
///
|
|
/// EFI_HOB_MEMORY_ALLOCATION_HEADER describes the
|
|
/// various attributes of the logical memory allocation. The type field will be used for
|
|
/// subsequent inclusion in the UEFI memory map.
|
|
///
|
|
typedef struct {
|
|
///
|
|
/// A GUID that defines the memory allocation region's type and purpose, as well as
|
|
/// other fields within the memory allocation HOB. This GUID is used to define the
|
|
/// additional data within the HOB that may be present for the memory allocation HOB.
|
|
/// Type EFI_GUID is defined in InstallProtocolInterface() in the UEFI 2.0
|
|
/// specification.
|
|
///
|
|
EFI_GUID Name;
|
|
|
|
///
|
|
/// The base address of memory allocated by this HOB. Type
|
|
/// EFI_PHYSICAL_ADDRESS is defined in AllocatePages() in the UEFI 2.0
|
|
/// specification.
|
|
///
|
|
EFI_PHYSICAL_ADDRESS MemoryBaseAddress;
|
|
|
|
///
|
|
/// The length in bytes of memory allocated by this HOB.
|
|
///
|
|
UINT64 MemoryLength;
|
|
|
|
///
|
|
/// Defines the type of memory allocated by this HOB. The memory type definition
|
|
/// follows the EFI_MEMORY_TYPE definition. Type EFI_MEMORY_TYPE is defined
|
|
/// in AllocatePages() in the UEFI 2.0 specification.
|
|
///
|
|
EFI_MEMORY_TYPE MemoryType;
|
|
|
|
///
|
|
/// Padding for Itanium processor family
|
|
///
|
|
UINT8 Reserved[4];
|
|
} EFI_HOB_MEMORY_ALLOCATION_HEADER;
|
|
|
|
///
|
|
/// Describes all memory ranges used during the HOB producer
|
|
/// phase that exist outside the HOB list. This HOB type
|
|
/// describes how memory is used, not the physical attributes of memory.
|
|
///
|
|
typedef struct {
|
|
///
|
|
/// The HOB generic header. Header.HobType = EFI_HOB_TYPE_MEMORY_ALLOCATION.
|
|
///
|
|
EFI_HOB_GENERIC_HEADER Header;
|
|
///
|
|
/// An instance of the EFI_HOB_MEMORY_ALLOCATION_HEADER that describes the
|
|
/// various attributes of the logical memory allocation.
|
|
///
|
|
EFI_HOB_MEMORY_ALLOCATION_HEADER AllocDescriptor;
|
|
//
|
|
// Additional data pertaining to the "Name" Guid memory
|
|
// may go here.
|
|
//
|
|
} EFI_HOB_MEMORY_ALLOCATION;
|
|
|
|
|
|
///
|
|
/// Describes the memory stack that is produced by the HOB producer
|
|
/// phase and upon which all post-memory-installed executable
|
|
/// content in the HOB producer phase is executing.
|
|
///
|
|
typedef struct {
|
|
///
|
|
/// The HOB generic header. Header.HobType = EFI_HOB_TYPE_MEMORY_ALLOCATION.
|
|
///
|
|
EFI_HOB_GENERIC_HEADER Header;
|
|
///
|
|
/// An instance of the EFI_HOB_MEMORY_ALLOCATION_HEADER that describes the
|
|
/// various attributes of the logical memory allocation.
|
|
///
|
|
EFI_HOB_MEMORY_ALLOCATION_HEADER AllocDescriptor;
|
|
} EFI_HOB_MEMORY_ALLOCATION_STACK;
|
|
|
|
///
|
|
/// Defines the location of the boot-strap
|
|
/// processor (BSP) BSPStore ("Backing Store Pointer Store").
|
|
/// This HOB is valid for the Itanium processor family only
|
|
/// register overflow store.
|
|
///
|
|
typedef struct {
|
|
///
|
|
/// The HOB generic header. Header.HobType = EFI_HOB_TYPE_MEMORY_ALLOCATION.
|
|
///
|
|
EFI_HOB_GENERIC_HEADER Header;
|
|
///
|
|
/// An instance of the EFI_HOB_MEMORY_ALLOCATION_HEADER that describes the
|
|
/// various attributes of the logical memory allocation.
|
|
///
|
|
EFI_HOB_MEMORY_ALLOCATION_HEADER AllocDescriptor;
|
|
} EFI_HOB_MEMORY_ALLOCATION_BSP_STORE;
|
|
|
|
///
|
|
/// Defines the location and entry point of the HOB consumer phase.
|
|
///
|
|
typedef struct {
|
|
///
|
|
/// The HOB generic header. Header.HobType = EFI_HOB_TYPE_MEMORY_ALLOCATION.
|
|
///
|
|
EFI_HOB_GENERIC_HEADER Header;
|
|
///
|
|
/// An instance of the EFI_HOB_MEMORY_ALLOCATION_HEADER that describes the
|
|
/// various attributes of the logical memory allocation.
|
|
///
|
|
EFI_HOB_MEMORY_ALLOCATION_HEADER MemoryAllocationHeader;
|
|
///
|
|
/// The GUID specifying the values of the firmware file system name
|
|
/// that contains the HOB consumer phase component.
|
|
///
|
|
EFI_GUID ModuleName;
|
|
///
|
|
/// The address of the memory-mapped firmware volume
|
|
/// that contains the HOB consumer phase firmware file.
|
|
///
|
|
EFI_PHYSICAL_ADDRESS EntryPoint;
|
|
} EFI_HOB_MEMORY_ALLOCATION_MODULE;
|
|
|
|
///
|
|
/// The resource type.
|
|
///
|
|
typedef UINT32 EFI_RESOURCE_TYPE;
|
|
|
|
//
|
|
// Value of ResourceType in EFI_HOB_RESOURCE_DESCRIPTOR.
|
|
//
|
|
#define EFI_RESOURCE_SYSTEM_MEMORY 0x00000000
|
|
#define EFI_RESOURCE_MEMORY_MAPPED_IO 0x00000001
|
|
#define EFI_RESOURCE_IO 0x00000002
|
|
#define EFI_RESOURCE_FIRMWARE_DEVICE 0x00000003
|
|
#define EFI_RESOURCE_MEMORY_MAPPED_IO_PORT 0x00000004
|
|
#define EFI_RESOURCE_MEMORY_RESERVED 0x00000005
|
|
#define EFI_RESOURCE_IO_RESERVED 0x00000006
|
|
#define EFI_RESOURCE_MAX_MEMORY_TYPE 0x00000007
|
|
|
|
///
|
|
/// A type of recount attribute type.
|
|
///
|
|
typedef UINT32 EFI_RESOURCE_ATTRIBUTE_TYPE;
|
|
|
|
//
|
|
// These types can be ORed together as needed.
|
|
//
|
|
// The following attributes are used to describe settings
|
|
//
|
|
#define EFI_RESOURCE_ATTRIBUTE_PRESENT 0x00000001
|
|
#define EFI_RESOURCE_ATTRIBUTE_INITIALIZED 0x00000002
|
|
#define EFI_RESOURCE_ATTRIBUTE_TESTED 0x00000004
|
|
#define EFI_RESOURCE_ATTRIBUTE_READ_PROTECTED 0x00000080
|
|
//
|
|
// This is typically used as memory cacheability attribute today.
|
|
// NOTE: Since PI spec 1.4, please use EFI_RESOURCE_ATTRIBUTE_READ_ONLY_PROTECTED
|
|
// as Physical write protected attribute, and EFI_RESOURCE_ATTRIBUTE_WRITE_PROTECTED
|
|
// means Memory cacheability attribute: The memory supports being programmed with
|
|
// a writeprotected cacheable attribute.
|
|
//
|
|
#define EFI_RESOURCE_ATTRIBUTE_WRITE_PROTECTED 0x00000100
|
|
#define EFI_RESOURCE_ATTRIBUTE_EXECUTION_PROTECTED 0x00000200
|
|
#define EFI_RESOURCE_ATTRIBUTE_PERSISTENT 0x00800000
|
|
//
|
|
// The rest of the attributes are used to describe capabilities
|
|
//
|
|
#define EFI_RESOURCE_ATTRIBUTE_SINGLE_BIT_ECC 0x00000008
|
|
#define EFI_RESOURCE_ATTRIBUTE_MULTIPLE_BIT_ECC 0x00000010
|
|
#define EFI_RESOURCE_ATTRIBUTE_ECC_RESERVED_1 0x00000020
|
|
#define EFI_RESOURCE_ATTRIBUTE_ECC_RESERVED_2 0x00000040
|
|
#define EFI_RESOURCE_ATTRIBUTE_UNCACHEABLE 0x00000400
|
|
#define EFI_RESOURCE_ATTRIBUTE_WRITE_COMBINEABLE 0x00000800
|
|
#define EFI_RESOURCE_ATTRIBUTE_WRITE_THROUGH_CACHEABLE 0x00001000
|
|
#define EFI_RESOURCE_ATTRIBUTE_WRITE_BACK_CACHEABLE 0x00002000
|
|
#define EFI_RESOURCE_ATTRIBUTE_16_BIT_IO 0x00004000
|
|
#define EFI_RESOURCE_ATTRIBUTE_32_BIT_IO 0x00008000
|
|
#define EFI_RESOURCE_ATTRIBUTE_64_BIT_IO 0x00010000
|
|
#define EFI_RESOURCE_ATTRIBUTE_UNCACHED_EXPORTED 0x00020000
|
|
#define EFI_RESOURCE_ATTRIBUTE_READ_PROTECTABLE 0x00100000
|
|
//
|
|
// This is typically used as memory cacheability attribute today.
|
|
// NOTE: Since PI spec 1.4, please use EFI_RESOURCE_ATTRIBUTE_READ_ONLY_PROTECTABLE
|
|
// as Memory capability attribute: The memory supports being protected from processor
|
|
// writes, and EFI_RESOURCE_ATTRIBUTE_WRITE_PROTEC TABLE means Memory cacheability attribute:
|
|
// The memory supports being programmed with a writeprotected cacheable attribute.
|
|
//
|
|
#define EFI_RESOURCE_ATTRIBUTE_WRITE_PROTECTABLE 0x00200000
|
|
#define EFI_RESOURCE_ATTRIBUTE_EXECUTION_PROTECTABLE 0x00400000
|
|
#define EFI_RESOURCE_ATTRIBUTE_PERSISTABLE 0x01000000
|
|
|
|
#define EFI_RESOURCE_ATTRIBUTE_READ_ONLY_PROTECTED 0x00040000
|
|
#define EFI_RESOURCE_ATTRIBUTE_READ_ONLY_PROTECTABLE 0x00080000
|
|
|
|
//
|
|
// Physical memory relative reliability attribute. This
|
|
// memory 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_RESOURCE_ATTRIBUTE_MORE_RELIABLE 0x02000000
|
|
|
|
///
|
|
/// Describes the resource properties of all fixed,
|
|
/// nonrelocatable resource ranges found on the processor
|
|
/// host bus during the HOB producer phase.
|
|
///
|
|
typedef struct {
|
|
///
|
|
/// The HOB generic header. Header.HobType = EFI_HOB_TYPE_RESOURCE_DESCRIPTOR.
|
|
///
|
|
EFI_HOB_GENERIC_HEADER Header;
|
|
///
|
|
/// A GUID representing the owner of the resource. This GUID is used by HOB
|
|
/// consumer phase components to correlate device ownership of a resource.
|
|
///
|
|
EFI_GUID Owner;
|
|
///
|
|
/// The resource type enumeration as defined by EFI_RESOURCE_TYPE.
|
|
///
|
|
EFI_RESOURCE_TYPE ResourceType;
|
|
///
|
|
/// Resource attributes as defined by EFI_RESOURCE_ATTRIBUTE_TYPE.
|
|
///
|
|
EFI_RESOURCE_ATTRIBUTE_TYPE ResourceAttribute;
|
|
///
|
|
/// The physical start address of the resource region.
|
|
///
|
|
EFI_PHYSICAL_ADDRESS PhysicalStart;
|
|
///
|
|
/// The number of bytes of the resource region.
|
|
///
|
|
UINT64 ResourceLength;
|
|
} EFI_HOB_RESOURCE_DESCRIPTOR;
|
|
|
|
///
|
|
/// Allows writers of executable content in the HOB producer phase to
|
|
/// maintain and manage HOBs with specific GUID.
|
|
///
|
|
typedef struct {
|
|
///
|
|
/// The HOB generic header. Header.HobType = EFI_HOB_TYPE_GUID_EXTENSION.
|
|
///
|
|
EFI_HOB_GENERIC_HEADER Header;
|
|
///
|
|
/// A GUID that defines the contents of this HOB.
|
|
///
|
|
EFI_GUID Name;
|
|
//
|
|
// Guid specific data goes here
|
|
//
|
|
} EFI_HOB_GUID_TYPE;
|
|
|
|
///
|
|
/// Details the location of firmware volumes that contain firmware files.
|
|
///
|
|
typedef struct {
|
|
///
|
|
/// The HOB generic header. Header.HobType = EFI_HOB_TYPE_FV.
|
|
///
|
|
EFI_HOB_GENERIC_HEADER Header;
|
|
///
|
|
/// The physical memory-mapped base address of the firmware volume.
|
|
///
|
|
EFI_PHYSICAL_ADDRESS BaseAddress;
|
|
///
|
|
/// The length in bytes of the firmware volume.
|
|
///
|
|
UINT64 Length;
|
|
} EFI_HOB_FIRMWARE_VOLUME;
|
|
|
|
///
|
|
/// Details the location of a firmware volume that was extracted
|
|
/// from a file within another firmware volume.
|
|
///
|
|
typedef struct {
|
|
///
|
|
/// The HOB generic header. Header.HobType = EFI_HOB_TYPE_FV2.
|
|
///
|
|
EFI_HOB_GENERIC_HEADER Header;
|
|
///
|
|
/// The physical memory-mapped base address of the firmware volume.
|
|
///
|
|
EFI_PHYSICAL_ADDRESS BaseAddress;
|
|
///
|
|
/// The length in bytes of the firmware volume.
|
|
///
|
|
UINT64 Length;
|
|
///
|
|
/// The name of the firmware volume.
|
|
///
|
|
EFI_GUID FvName;
|
|
///
|
|
/// The name of the firmware file that contained this firmware volume.
|
|
///
|
|
EFI_GUID FileName;
|
|
} EFI_HOB_FIRMWARE_VOLUME2;
|
|
|
|
///
|
|
/// Details the location of a firmware volume that was extracted
|
|
/// from a file within another firmware volume.
|
|
///
|
|
typedef struct {
|
|
///
|
|
/// The HOB generic header. Header.HobType = EFI_HOB_TYPE_FV3.
|
|
///
|
|
EFI_HOB_GENERIC_HEADER Header;
|
|
///
|
|
/// The physical memory-mapped base address of the firmware volume.
|
|
///
|
|
EFI_PHYSICAL_ADDRESS BaseAddress;
|
|
///
|
|
/// The length in bytes of the firmware volume.
|
|
///
|
|
UINT64 Length;
|
|
///
|
|
/// The authentication status.
|
|
///
|
|
UINT32 AuthenticationStatus;
|
|
///
|
|
/// TRUE if the FV was extracted as a file within another firmware volume.
|
|
/// FALSE otherwise.
|
|
///
|
|
BOOLEAN ExtractedFv;
|
|
///
|
|
/// The name of the firmware volume.
|
|
/// Valid only if IsExtractedFv is TRUE.
|
|
///
|
|
EFI_GUID FvName;
|
|
///
|
|
/// The name of the firmware file that contained this firmware volume.
|
|
/// Valid only if IsExtractedFv is TRUE.
|
|
///
|
|
EFI_GUID FileName;
|
|
} EFI_HOB_FIRMWARE_VOLUME3;
|
|
|
|
///
|
|
/// Describes processor information, such as address space and I/O space capabilities.
|
|
///
|
|
typedef struct {
|
|
///
|
|
/// The HOB generic header. Header.HobType = EFI_HOB_TYPE_CPU.
|
|
///
|
|
EFI_HOB_GENERIC_HEADER Header;
|
|
///
|
|
/// Identifies the maximum physical memory addressability of the processor.
|
|
///
|
|
UINT8 SizeOfMemorySpace;
|
|
///
|
|
/// Identifies the maximum physical I/O addressability of the processor.
|
|
///
|
|
UINT8 SizeOfIoSpace;
|
|
///
|
|
/// This field will always be set to zero.
|
|
///
|
|
UINT8 Reserved[6];
|
|
} EFI_HOB_CPU;
|
|
|
|
|
|
///
|
|
/// Describes pool memory allocations.
|
|
///
|
|
typedef struct {
|
|
///
|
|
/// The HOB generic header. Header.HobType = EFI_HOB_TYPE_MEMORY_POOL.
|
|
///
|
|
EFI_HOB_GENERIC_HEADER Header;
|
|
} EFI_HOB_MEMORY_POOL;
|
|
|
|
///
|
|
/// Each UEFI capsule HOB details the location of a UEFI capsule. It includes a base address and length
|
|
/// which is based upon memory blocks with a EFI_CAPSULE_HEADER and the associated
|
|
/// CapsuleImageSize-based payloads. These HOB's shall be created by the PEI PI firmware
|
|
/// sometime after the UEFI UpdateCapsule service invocation with the
|
|
/// CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE flag set in the EFI_CAPSULE_HEADER.
|
|
///
|
|
typedef struct {
|
|
///
|
|
/// The HOB generic header where Header.HobType = EFI_HOB_TYPE_UEFI_CAPSULE.
|
|
///
|
|
EFI_HOB_GENERIC_HEADER Header;
|
|
|
|
///
|
|
/// The physical memory-mapped base address of an UEFI capsule. This value is set to
|
|
/// point to the base of the contiguous memory of the UEFI capsule.
|
|
/// The length of the contiguous memory in bytes.
|
|
///
|
|
EFI_PHYSICAL_ADDRESS BaseAddress;
|
|
UINT64 Length;
|
|
} EFI_HOB_UEFI_CAPSULE;
|
|
|
|
///
|
|
/// Union of all the possible HOB Types.
|
|
///
|
|
typedef union {
|
|
EFI_HOB_GENERIC_HEADER *Header;
|
|
EFI_HOB_HANDOFF_INFO_TABLE *HandoffInformationTable;
|
|
EFI_HOB_MEMORY_ALLOCATION *MemoryAllocation;
|
|
EFI_HOB_MEMORY_ALLOCATION_BSP_STORE *MemoryAllocationBspStore;
|
|
EFI_HOB_MEMORY_ALLOCATION_STACK *MemoryAllocationStack;
|
|
EFI_HOB_MEMORY_ALLOCATION_MODULE *MemoryAllocationModule;
|
|
EFI_HOB_RESOURCE_DESCRIPTOR *ResourceDescriptor;
|
|
EFI_HOB_GUID_TYPE *Guid;
|
|
EFI_HOB_FIRMWARE_VOLUME *FirmwareVolume;
|
|
EFI_HOB_FIRMWARE_VOLUME2 *FirmwareVolume2;
|
|
EFI_HOB_FIRMWARE_VOLUME3 *FirmwareVolume3;
|
|
EFI_HOB_CPU *Cpu;
|
|
EFI_HOB_MEMORY_POOL *Pool;
|
|
EFI_HOB_UEFI_CAPSULE *Capsule;
|
|
UINT8 *Raw;
|
|
} EFI_PEI_HOB_POINTERS;
|
|
|
|
|
|
#endif
|