HOB related definitions in PI. More...

Data Structures
struct	EFI_HOB_GENERIC_HEADER
	Describes the format and size of the data inside the HOB. More...

struct	EFI_HOB_HANDOFF_INFO_TABLE
	Contains general state information used by the HOB producer phase. More...

struct	EFI_HOB_MEMORY_ALLOCATION_HEADER
	EFI_HOB_MEMORY_ALLOCATION_HEADER describes the various attributes of the logical memory allocation. More...

struct	EFI_HOB_MEMORY_ALLOCATION
	Describes all memory ranges used during the HOB producer phase that exist outside the HOB list. More...

struct	EFI_HOB_MEMORY_ALLOCATION_STACK
	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. More...

struct	EFI_HOB_MEMORY_ALLOCATION_BSP_STORE
	Defines the location of the boot-strap processor (BSP) BSPStore ("Backing Store Pointer Store"). More...

struct	EFI_HOB_MEMORY_ALLOCATION_MODULE
	Defines the location and entry point of the HOB consumer phase. More...

struct	EFI_HOB_RESOURCE_DESCRIPTOR
	Describes the resource properties of all fixed, nonrelocatable resource ranges found on the processor host bus during the HOB producer phase. More...

struct	EFI_HOB_GUID_TYPE
	Allows writers of executable content in the HOB producer phase to maintain and manage HOBs with specific GUID. More...

struct	EFI_HOB_FIRMWARE_VOLUME
	Details the location of firmware volumes that contain firmware files. More...

struct	EFI_HOB_FIRMWARE_VOLUME2
	Details the location of a firmware volume that was extracted from a file within another firmware volume. More...

struct	EFI_HOB_FIRMWARE_VOLUME3
	Details the location of a firmware volume that was extracted from a file within another firmware volume. More...

struct	EFI_HOB_CPU
	Describes processor information, such as address space and I/O space capabilities. More...

struct	EFI_HOB_MEMORY_POOL
	Describes pool memory allocations. More...

struct	EFI_HOB_UEFI_CAPSULE
	Each UEFI capsule HOB details the location of a UEFI capsule. More...

union	EFI_PEI_HOB_POINTERS
	Union of all the possible HOB Types. More...

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

#define	EFI_HOB_HANDOFF_TABLE_VERSION 0x0009
	Value of version in EFI_HOB_HANDOFF_INFO_TABLE. More...

#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_MEMORY_UNACCEPTED 0x00000007

#define	EFI_RESOURCE_MAX_MEMORY_TYPE 0x00000008

#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

#define	EFI_RESOURCE_ATTRIBUTE_WRITE_PROTECTED 0x00000100

#define	EFI_RESOURCE_ATTRIBUTE_EXECUTION_PROTECTED 0x00000200

#define	EFI_RESOURCE_ATTRIBUTE_PERSISTENT 0x00800000

#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

#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

#define	EFI_RESOURCE_ATTRIBUTE_ENCRYPTED 0x04000000

#define	EFI_RESOURCE_ATTRIBUTE_SPECIAL_PURPOSE 0x08000000

#define	EFI_RESOURCE_ATTRIBUTE_HOT_PLUGGABLE 0x10000000

#define	EFI_RESOURCE_ATTRIBUTE_MORE_RELIABLE 0x02000000

Typedefs
typedef UINT32	EFI_RESOURCE_TYPE
	The resource type. More...

typedef UINT32	EFI_RESOURCE_ATTRIBUTE_TYPE
	A type of recount attribute type. More...

Functions
	FILE_LICENCE (BSD2_PATENT)

Detailed Description

HOB related definitions in PI.

Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Revision Reference:: PI Version 1.9

Definition in file PiHob.h.

Macro Definition Documentation

◆ EFI_HOB_TYPE_HANDOFF

#define EFI_HOB_TYPE_HANDOFF 0x0001

Definition at line 20 of file PiHob.h.

◆ EFI_HOB_TYPE_MEMORY_ALLOCATION

#define EFI_HOB_TYPE_MEMORY_ALLOCATION 0x0002

Definition at line 21 of file PiHob.h.

◆ EFI_HOB_TYPE_RESOURCE_DESCRIPTOR

#define EFI_HOB_TYPE_RESOURCE_DESCRIPTOR 0x0003

Definition at line 22 of file PiHob.h.

◆ EFI_HOB_TYPE_GUID_EXTENSION

#define EFI_HOB_TYPE_GUID_EXTENSION 0x0004

Definition at line 23 of file PiHob.h.

◆ EFI_HOB_TYPE_FV

#define EFI_HOB_TYPE_FV 0x0005

Definition at line 24 of file PiHob.h.

◆ EFI_HOB_TYPE_CPU

#define EFI_HOB_TYPE_CPU 0x0006

Definition at line 25 of file PiHob.h.

◆ EFI_HOB_TYPE_MEMORY_POOL

#define EFI_HOB_TYPE_MEMORY_POOL 0x0007

Definition at line 26 of file PiHob.h.

◆ EFI_HOB_TYPE_FV2

#define EFI_HOB_TYPE_FV2 0x0009

Definition at line 27 of file PiHob.h.

◆ EFI_HOB_TYPE_LOAD_PEIM_UNUSED

#define EFI_HOB_TYPE_LOAD_PEIM_UNUSED 0x000A

Definition at line 28 of file PiHob.h.

◆ EFI_HOB_TYPE_UEFI_CAPSULE

#define EFI_HOB_TYPE_UEFI_CAPSULE 0x000B

Definition at line 29 of file PiHob.h.

◆ EFI_HOB_TYPE_FV3

#define EFI_HOB_TYPE_FV3 0x000C

Definition at line 30 of file PiHob.h.

◆ EFI_HOB_TYPE_UNUSED

#define EFI_HOB_TYPE_UNUSED 0xFFFE

Definition at line 31 of file PiHob.h.

◆ EFI_HOB_TYPE_END_OF_HOB_LIST

#define EFI_HOB_TYPE_END_OF_HOB_LIST 0xFFFF

Definition at line 32 of file PiHob.h.

◆ EFI_HOB_HANDOFF_TABLE_VERSION

#define EFI_HOB_HANDOFF_TABLE_VERSION 0x0009

Value of version in EFI_HOB_HANDOFF_INFO_TABLE.

Definition at line 56 of file PiHob.h.

◆ EFI_RESOURCE_SYSTEM_MEMORY

#define EFI_RESOURCE_SYSTEM_MEMORY 0x00000000

Definition at line 230 of file PiHob.h.

◆ EFI_RESOURCE_MEMORY_MAPPED_IO

#define EFI_RESOURCE_MEMORY_MAPPED_IO 0x00000001

Definition at line 231 of file PiHob.h.

◆ EFI_RESOURCE_IO

#define EFI_RESOURCE_IO 0x00000002

Definition at line 232 of file PiHob.h.

◆ EFI_RESOURCE_FIRMWARE_DEVICE

#define EFI_RESOURCE_FIRMWARE_DEVICE 0x00000003

Definition at line 233 of file PiHob.h.

◆ EFI_RESOURCE_MEMORY_MAPPED_IO_PORT

#define EFI_RESOURCE_MEMORY_MAPPED_IO_PORT 0x00000004

Definition at line 234 of file PiHob.h.

◆ EFI_RESOURCE_MEMORY_RESERVED

#define EFI_RESOURCE_MEMORY_RESERVED 0x00000005

Definition at line 235 of file PiHob.h.

◆ EFI_RESOURCE_IO_RESERVED

#define EFI_RESOURCE_IO_RESERVED 0x00000006

Definition at line 236 of file PiHob.h.

◆ EFI_RESOURCE_MEMORY_UNACCEPTED

#define EFI_RESOURCE_MEMORY_UNACCEPTED 0x00000007

Definition at line 237 of file PiHob.h.

◆ EFI_RESOURCE_MAX_MEMORY_TYPE

#define EFI_RESOURCE_MAX_MEMORY_TYPE 0x00000008

Definition at line 238 of file PiHob.h.

◆ EFI_RESOURCE_ATTRIBUTE_PRESENT

#define EFI_RESOURCE_ATTRIBUTE_PRESENT 0x00000001

Definition at line 250 of file PiHob.h.

◆ EFI_RESOURCE_ATTRIBUTE_INITIALIZED

#define EFI_RESOURCE_ATTRIBUTE_INITIALIZED 0x00000002

Definition at line 251 of file PiHob.h.

◆ EFI_RESOURCE_ATTRIBUTE_TESTED

#define EFI_RESOURCE_ATTRIBUTE_TESTED 0x00000004

Definition at line 252 of file PiHob.h.

◆ EFI_RESOURCE_ATTRIBUTE_READ_PROTECTED

#define EFI_RESOURCE_ATTRIBUTE_READ_PROTECTED 0x00000080

Definition at line 253 of file PiHob.h.

◆ EFI_RESOURCE_ATTRIBUTE_WRITE_PROTECTED

#define EFI_RESOURCE_ATTRIBUTE_WRITE_PROTECTED 0x00000100

Definition at line 261 of file PiHob.h.

◆ EFI_RESOURCE_ATTRIBUTE_EXECUTION_PROTECTED

#define EFI_RESOURCE_ATTRIBUTE_EXECUTION_PROTECTED 0x00000200

Definition at line 262 of file PiHob.h.

◆ EFI_RESOURCE_ATTRIBUTE_PERSISTENT

#define EFI_RESOURCE_ATTRIBUTE_PERSISTENT 0x00800000

Definition at line 263 of file PiHob.h.

◆ EFI_RESOURCE_ATTRIBUTE_SINGLE_BIT_ECC

#define EFI_RESOURCE_ATTRIBUTE_SINGLE_BIT_ECC 0x00000008

Definition at line 267 of file PiHob.h.

◆ EFI_RESOURCE_ATTRIBUTE_MULTIPLE_BIT_ECC

#define EFI_RESOURCE_ATTRIBUTE_MULTIPLE_BIT_ECC 0x00000010

Definition at line 268 of file PiHob.h.

◆ EFI_RESOURCE_ATTRIBUTE_ECC_RESERVED_1

#define EFI_RESOURCE_ATTRIBUTE_ECC_RESERVED_1 0x00000020

Definition at line 269 of file PiHob.h.

◆ EFI_RESOURCE_ATTRIBUTE_ECC_RESERVED_2

#define EFI_RESOURCE_ATTRIBUTE_ECC_RESERVED_2 0x00000040

Definition at line 270 of file PiHob.h.

◆ EFI_RESOURCE_ATTRIBUTE_UNCACHEABLE

#define EFI_RESOURCE_ATTRIBUTE_UNCACHEABLE 0x00000400

Definition at line 271 of file PiHob.h.

◆ EFI_RESOURCE_ATTRIBUTE_WRITE_COMBINEABLE

#define EFI_RESOURCE_ATTRIBUTE_WRITE_COMBINEABLE 0x00000800

Definition at line 272 of file PiHob.h.

◆ EFI_RESOURCE_ATTRIBUTE_WRITE_THROUGH_CACHEABLE

#define EFI_RESOURCE_ATTRIBUTE_WRITE_THROUGH_CACHEABLE 0x00001000

Definition at line 273 of file PiHob.h.

◆ EFI_RESOURCE_ATTRIBUTE_WRITE_BACK_CACHEABLE

#define EFI_RESOURCE_ATTRIBUTE_WRITE_BACK_CACHEABLE 0x00002000

Definition at line 274 of file PiHob.h.

◆ EFI_RESOURCE_ATTRIBUTE_16_BIT_IO

#define EFI_RESOURCE_ATTRIBUTE_16_BIT_IO 0x00004000

Definition at line 275 of file PiHob.h.

◆ EFI_RESOURCE_ATTRIBUTE_32_BIT_IO

#define EFI_RESOURCE_ATTRIBUTE_32_BIT_IO 0x00008000

Definition at line 276 of file PiHob.h.

◆ EFI_RESOURCE_ATTRIBUTE_64_BIT_IO

#define EFI_RESOURCE_ATTRIBUTE_64_BIT_IO 0x00010000

Definition at line 277 of file PiHob.h.

◆ EFI_RESOURCE_ATTRIBUTE_UNCACHED_EXPORTED

#define EFI_RESOURCE_ATTRIBUTE_UNCACHED_EXPORTED 0x00020000

Definition at line 278 of file PiHob.h.

◆ EFI_RESOURCE_ATTRIBUTE_READ_PROTECTABLE

#define EFI_RESOURCE_ATTRIBUTE_READ_PROTECTABLE 0x00100000

Definition at line 279 of file PiHob.h.

◆ EFI_RESOURCE_ATTRIBUTE_WRITE_PROTECTABLE

#define EFI_RESOURCE_ATTRIBUTE_WRITE_PROTECTABLE 0x00200000

Definition at line 287 of file PiHob.h.

◆ EFI_RESOURCE_ATTRIBUTE_EXECUTION_PROTECTABLE

#define EFI_RESOURCE_ATTRIBUTE_EXECUTION_PROTECTABLE 0x00400000

Definition at line 288 of file PiHob.h.

◆ EFI_RESOURCE_ATTRIBUTE_PERSISTABLE

#define EFI_RESOURCE_ATTRIBUTE_PERSISTABLE 0x01000000

Definition at line 289 of file PiHob.h.

◆ EFI_RESOURCE_ATTRIBUTE_READ_ONLY_PROTECTED

#define EFI_RESOURCE_ATTRIBUTE_READ_ONLY_PROTECTED 0x00040000

Definition at line 291 of file PiHob.h.

◆ EFI_RESOURCE_ATTRIBUTE_READ_ONLY_PROTECTABLE

#define EFI_RESOURCE_ATTRIBUTE_READ_ONLY_PROTECTABLE 0x00080000

Definition at line 292 of file PiHob.h.

◆ EFI_RESOURCE_ATTRIBUTE_ENCRYPTED

#define EFI_RESOURCE_ATTRIBUTE_ENCRYPTED 0x04000000

Definition at line 294 of file PiHob.h.

◆ EFI_RESOURCE_ATTRIBUTE_SPECIAL_PURPOSE

#define EFI_RESOURCE_ATTRIBUTE_SPECIAL_PURPOSE 0x08000000

Definition at line 295 of file PiHob.h.

◆ EFI_RESOURCE_ATTRIBUTE_HOT_PLUGGABLE

#define EFI_RESOURCE_ATTRIBUTE_HOT_PLUGGABLE 0x10000000

Definition at line 296 of file PiHob.h.

◆ EFI_RESOURCE_ATTRIBUTE_MORE_RELIABLE

#define EFI_RESOURCE_ATTRIBUTE_MORE_RELIABLE 0x02000000

Definition at line 303 of file PiHob.h.

Typedef Documentation

◆ EFI_RESOURCE_TYPE

typedef UINT32 EFI_RESOURCE_TYPE

The resource type.

Definition at line 225 of file PiHob.h.

◆ EFI_RESOURCE_ATTRIBUTE_TYPE

typedef UINT32 EFI_RESOURCE_ATTRIBUTE_TYPE

A type of recount attribute type.

Definition at line 243 of file PiHob.h.

Function Documentation

◆ FILE_LICENCE()

FILE_LICENCE ( BSD2_PATENT )

Data Structures

Macros

Typedefs

Functions