2 HOB related definitions in PI.
4 Copyright (c) 2006 - 2008, Intel Corporation
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
13 @par Revision Reference:
21 #include <ProcessorBind.h>
22 #include <Pi/PiBootMode.h>
23 #include <Uefi/UefiBaseType.h>
24 #include <Uefi/UefiMultiPhase.h>
27 // HobType of EFI_HOB_GENERIC_HEADER.
29 #define EFI_HOB_TYPE_HANDOFF 0x0001
30 #define EFI_HOB_TYPE_MEMORY_ALLOCATION 0x0002
31 #define EFI_HOB_TYPE_RESOURCE_DESCRIPTOR 0x0003
32 #define EFI_HOB_TYPE_GUID_EXTENSION 0x0004
33 #define EFI_HOB_TYPE_FV 0x0005
34 #define EFI_HOB_TYPE_CPU 0x0006
35 #define EFI_HOB_TYPE_MEMORY_POOL 0x0007
36 #define EFI_HOB_TYPE_FV2 0x0009
37 #define EFI_HOB_TYPE_LOAD_PEIM 0x000A
38 #define EFI_HOB_TYPE_UNUSED 0xFFFE
39 #define EFI_HOB_TYPE_END_OF_HOB_LIST 0xFFFF
42 /// Describes the format and size of the data inside the HOB.
43 /// All HOBs must contain this generic HOB header.
49 } EFI_HOB_GENERIC_HEADER
;
53 /// Value of version ofinEFI_HOB_HANDOFF_INFO_TABLE.
55 #define EFI_HOB_HANDOFF_TABLE_VERSION 0x0009
58 /// Contains general state information used by the HOB producer phase.
59 /// This HOB must be the first one in the HOB list.
62 EFI_HOB_GENERIC_HEADER Header
;
64 EFI_BOOT_MODE BootMode
;
65 EFI_PHYSICAL_ADDRESS EfiMemoryTop
;
66 EFI_PHYSICAL_ADDRESS EfiMemoryBottom
;
67 EFI_PHYSICAL_ADDRESS EfiFreeMemoryTop
;
68 EFI_PHYSICAL_ADDRESS EfiFreeMemoryBottom
;
69 EFI_PHYSICAL_ADDRESS EfiEndOfHobList
;
70 } EFI_HOB_HANDOFF_INFO_TABLE
;
73 /// EFI_HOB_MEMORY_ALLOCATION_HEADER describes the
74 /// various attributes of the logical memory allocation. The type field will be used for
75 /// subsequent inclusion in the UEFI memory map.
79 /// A GUID that defines the memory allocation region¡¯s type and purpose, as well as
80 /// other fields within the memory allocation HOB. This GUID is used to define the
81 /// additional data within the HOB that may be present for the memory allocation HOB.
82 /// Type EFI_GUID is defined in InstallProtocolInterface() in the UEFI 2.0
87 /// The base address of memory allocated by this HOB. Type
88 /// EFI_PHYSICAL_ADDRESS is defined in AllocatePages() in the UEFI 2.0
90 EFI_PHYSICAL_ADDRESS MemoryBaseAddress
;
93 /// The length in bytes of memory allocated by this HOB.
98 /// Defines the type of memory allocated by this HOB. The memory type definition
99 /// follows the EFI_MEMORY_TYPE definition. Type EFI_MEMORY_TYPE is defined
100 /// in AllocatePages() in the UEFI 2.0 specification.
102 EFI_MEMORY_TYPE MemoryType
;
105 /// Padding for Itanium processor family
108 } EFI_HOB_MEMORY_ALLOCATION_HEADER
;
111 /// Describes all memory ranges used during the HOB producer
112 /// phase that exist outside the HOB list. This HOB type
113 /// describes how memory is used,
114 /// not the physical attributes of memory.
117 EFI_HOB_GENERIC_HEADER Header
;
118 EFI_HOB_MEMORY_ALLOCATION_HEADER AllocDescriptor
;
120 // Additional data pertaining to the "Name" Guid memory
123 } EFI_HOB_MEMORY_ALLOCATION
;
127 /// Describes the memory stack that is produced by the HOB producer
128 /// phase and upon which all postmemory-installed executable
129 /// content in the HOB producer phase is executing.
132 EFI_HOB_GENERIC_HEADER Header
;
133 EFI_HOB_MEMORY_ALLOCATION_HEADER AllocDescriptor
;
134 } EFI_HOB_MEMORY_ALLOCATION_STACK
;
137 /// Defines the location of the boot-strap
138 /// processor (BSP) BSPStore ("Backing Store Pointer Store").
139 /// This HOB is valid for the Itanium processor family only
140 /// register overflow store.
143 EFI_HOB_GENERIC_HEADER Header
;
144 EFI_HOB_MEMORY_ALLOCATION_HEADER AllocDescriptor
;
145 } EFI_HOB_MEMORY_ALLOCATION_BSP_STORE
;
148 /// Defines the location and entry point of the HOB consumer phase.
151 EFI_HOB_GENERIC_HEADER Header
;
152 EFI_HOB_MEMORY_ALLOCATION_HEADER MemoryAllocationHeader
;
154 EFI_PHYSICAL_ADDRESS EntryPoint
;
155 } EFI_HOB_MEMORY_ALLOCATION_MODULE
;
158 /// type of Recount type
160 typedef UINT32 EFI_RESOURCE_TYPE
;
163 // Value of ResourceType in EFI_HOB_RESOURCE_DESCRIPTOR.
165 #define EFI_RESOURCE_SYSTEM_MEMORY 0x00000000
166 #define EFI_RESOURCE_MEMORY_MAPPED_IO 0x00000001
167 #define EFI_RESOURCE_IO 0x00000002
168 #define EFI_RESOURCE_FIRMWARE_DEVICE 0x00000003
169 #define EFI_RESOURCE_MEMORY_MAPPED_IO_PORT 0x00000004
170 #define EFI_RESOURCE_MEMORY_RESERVED 0x00000005
171 #define EFI_RESOURCE_IO_RESERVED 0x00000006
172 #define EFI_RESOURCE_MAX_MEMORY_TYPE 0x00000007
175 /// type of recount attribute type
177 typedef UINT32 EFI_RESOURCE_ATTRIBUTE_TYPE
;
180 // These types can be ORed together as needed.
182 // The first three enumerations describe settings
184 #define EFI_RESOURCE_ATTRIBUTE_PRESENT 0x00000001
185 #define EFI_RESOURCE_ATTRIBUTE_INITIALIZED 0x00000002
186 #define EFI_RESOURCE_ATTRIBUTE_TESTED 0x00000004
188 // The rest of the settings describe capabilities
190 #define EFI_RESOURCE_ATTRIBUTE_SINGLE_BIT_ECC 0x00000008
191 #define EFI_RESOURCE_ATTRIBUTE_MULTIPLE_BIT_ECC 0x00000010
192 #define EFI_RESOURCE_ATTRIBUTE_ECC_RESERVED_1 0x00000020
193 #define EFI_RESOURCE_ATTRIBUTE_ECC_RESERVED_2 0x00000040
194 #define EFI_RESOURCE_ATTRIBUTE_READ_PROTECTED 0x00000080
195 #define EFI_RESOURCE_ATTRIBUTE_WRITE_PROTECTED 0x00000100
196 #define EFI_RESOURCE_ATTRIBUTE_EXECUTION_PROTECTED 0x00000200
197 #define EFI_RESOURCE_ATTRIBUTE_UNCACHEABLE 0x00000400
198 #define EFI_RESOURCE_ATTRIBUTE_WRITE_COMBINEABLE 0x00000800
199 #define EFI_RESOURCE_ATTRIBUTE_WRITE_THROUGH_CACHEABLE 0x00001000
200 #define EFI_RESOURCE_ATTRIBUTE_WRITE_BACK_CACHEABLE 0x00002000
201 #define EFI_RESOURCE_ATTRIBUTE_16_BIT_IO 0x00004000
202 #define EFI_RESOURCE_ATTRIBUTE_32_BIT_IO 0x00008000
203 #define EFI_RESOURCE_ATTRIBUTE_64_BIT_IO 0x00010000
204 #define EFI_RESOURCE_ATTRIBUTE_UNCACHED_EXPORTED 0x00020000
207 /// Describes the resource properties of all fixed,
208 /// nonrelocatable resource ranges found on the processor
209 /// host bus during the HOB producer phase.
212 EFI_HOB_GENERIC_HEADER Header
;
214 EFI_RESOURCE_TYPE ResourceType
;
215 EFI_RESOURCE_ATTRIBUTE_TYPE ResourceAttribute
;
216 EFI_PHYSICAL_ADDRESS PhysicalStart
;
217 UINT64 ResourceLength
;
218 } EFI_HOB_RESOURCE_DESCRIPTOR
;
221 /// Allows writers of executable content in the HOB producer phase to
222 /// maintain and manage HOBs with specific GUID.
225 EFI_HOB_GENERIC_HEADER Header
;
229 /// Guid specific data goes here
234 /// Details the location of firmware volumes that contain firmware files.
237 EFI_HOB_GENERIC_HEADER Header
;
238 EFI_PHYSICAL_ADDRESS BaseAddress
;
240 } EFI_HOB_FIRMWARE_VOLUME
;
243 /// Details the location of a firmware volume which was extracted
244 /// from a file within another firmware volume.
247 EFI_HOB_GENERIC_HEADER Header
;
248 EFI_PHYSICAL_ADDRESS BaseAddress
;
252 } EFI_HOB_FIRMWARE_VOLUME2
;
256 /// Describes processor information, such as address space and I/O space capabilities.
259 EFI_HOB_GENERIC_HEADER Header
;
260 UINT8 SizeOfMemorySpace
;
267 /// Describes pool memory allocations.
270 EFI_HOB_GENERIC_HEADER Header
;
271 } EFI_HOB_MEMORY_POOL
;
274 /// Union of all the possible HOB Types
277 EFI_HOB_GENERIC_HEADER
*Header
;
278 EFI_HOB_HANDOFF_INFO_TABLE
*HandoffInformationTable
;
279 EFI_HOB_MEMORY_ALLOCATION
*MemoryAllocation
;
280 EFI_HOB_MEMORY_ALLOCATION_BSP_STORE
*MemoryAllocationBspStore
;
281 EFI_HOB_MEMORY_ALLOCATION_STACK
*MemoryAllocationStack
;
282 EFI_HOB_MEMORY_ALLOCATION_MODULE
*MemoryAllocationModule
;
283 EFI_HOB_RESOURCE_DESCRIPTOR
*ResourceDescriptor
;
284 EFI_HOB_GUID_TYPE
*Guid
;
285 EFI_HOB_FIRMWARE_VOLUME
*FirmwareVolume
;
286 EFI_HOB_FIRMWARE_VOLUME2
*FirmwareVolume2
;
288 EFI_HOB_MEMORY_POOL
*Pool
;
290 } EFI_PEI_HOB_POINTERS
;