2 HOB related definitions in PI.
4 Copyright (c) 2006 - 2007, 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:
22 // HobType of EFI_HOB_GENERIC_HEADER.
24 #define EFI_HOB_TYPE_HANDOFF 0x0001
25 #define EFI_HOB_TYPE_MEMORY_ALLOCATION 0x0002
26 #define EFI_HOB_TYPE_RESOURCE_DESCRIPTOR 0x0003
27 #define EFI_HOB_TYPE_GUID_EXTENSION 0x0004
28 #define EFI_HOB_TYPE_FV 0x0005
29 #define EFI_HOB_TYPE_CPU 0x0006
30 #define EFI_HOB_TYPE_MEMORY_POOL 0x0007
31 #define EFI_HOB_TYPE_FV2 0x0009
32 #define EFI_HOB_TYPE_LOAD_PEIM 0x000A
33 #define EFI_HOB_TYPE_UNUSED 0xFFFE
34 #define EFI_HOB_TYPE_END_OF_HOB_LIST 0xFFFF
37 // Describes the format and size of the data inside the HOB.
38 // All HOBs must contain this generic HOB header.
44 } EFI_HOB_GENERIC_HEADER
;
48 // Value of version ofinEFI_HOB_HANDOFF_INFO_TABLE.
50 #define EFI_HOB_HANDOFF_TABLE_VERSION 0x0009
52 // Contains general state information used by the HOB producer phase.
53 // This HOB must be the first one in the HOB list.
56 EFI_HOB_GENERIC_HEADER Header
;
58 EFI_BOOT_MODE BootMode
;
59 EFI_PHYSICAL_ADDRESS EfiMemoryTop
;
60 EFI_PHYSICAL_ADDRESS EfiMemoryBottom
;
61 EFI_PHYSICAL_ADDRESS EfiFreeMemoryTop
;
62 EFI_PHYSICAL_ADDRESS EfiFreeMemoryBottom
;
63 EFI_PHYSICAL_ADDRESS EfiEndOfHobList
;
64 } EFI_HOB_HANDOFF_INFO_TABLE
;
69 EFI_PHYSICAL_ADDRESS MemoryBaseAddress
;
71 EFI_MEMORY_TYPE MemoryType
;
74 // Padding for Itanium processor family
77 } EFI_HOB_MEMORY_ALLOCATION_HEADER
;
80 // Describes all memory ranges used during the HOB producer
81 // phase that exist outside the HOB list. This HOB type
82 // describes how memory is used,
83 // not the physical attributes of memory.
86 EFI_HOB_GENERIC_HEADER Header
;
87 EFI_HOB_MEMORY_ALLOCATION_HEADER AllocDescriptor
;
89 // Additional data pertaining to the ¡°Name¡± Guid memory
92 } EFI_HOB_MEMORY_ALLOCATION
;
96 // Describes the memory stack that is produced by the HOB producer
97 // phase and upon which all postmemory-installed executable
98 // content in the HOB producer phase is executing.
101 EFI_HOB_GENERIC_HEADER Header
;
102 EFI_HOB_MEMORY_ALLOCATION_HEADER AllocDescriptor
;
103 } EFI_HOB_MEMORY_ALLOCATION_STACK
;
106 // Defines the location of the boot-strap
107 // processor (BSP) BSPStore (¡°Backing Store Pointer Store¡±).
108 // This HOB is valid for the Itanium processor family only
109 // register overflow store.
112 EFI_HOB_GENERIC_HEADER Header
;
113 EFI_HOB_MEMORY_ALLOCATION_HEADER AllocDescriptor
;
114 } EFI_HOB_MEMORY_ALLOCATION_BSP_STORE
;
117 // Defines the location and entry point of the HOB consumer phase.
120 EFI_HOB_GENERIC_HEADER Header
;
121 EFI_HOB_MEMORY_ALLOCATION_HEADER MemoryAllocationHeader
;
123 EFI_PHYSICAL_ADDRESS EntryPoint
;
124 } EFI_HOB_MEMORY_ALLOCATION_MODULE
;
126 typedef UINT32 EFI_RESOURCE_TYPE
;
129 // Value of ResourceType in EFI_HOB_RESOURCE_DESCRIPTOR.
131 #define EFI_RESOURCE_SYSTEM_MEMORY 0x00000000
132 #define EFI_RESOURCE_MEMORY_MAPPED_IO 0x00000001
133 #define EFI_RESOURCE_IO 0x00000002
134 #define EFI_RESOURCE_FIRMWARE_DEVICE 0x00000003
135 #define EFI_RESOURCE_MEMORY_MAPPED_IO_PORT 0x00000004
136 #define EFI_RESOURCE_MEMORY_RESERVED 0x00000005
137 #define EFI_RESOURCE_IO_RESERVED 0x00000006
138 #define EFI_RESOURCE_MAX_MEMORY_TYPE 0x00000007
141 typedef UINT32 EFI_RESOURCE_ATTRIBUTE_TYPE
;
144 // These types can be ORed together as needed.
146 // The first three enumerations describe settings
148 #define EFI_RESOURCE_ATTRIBUTE_PRESENT 0x00000001
149 #define EFI_RESOURCE_ATTRIBUTE_INITIALIZED 0x00000002
150 #define EFI_RESOURCE_ATTRIBUTE_TESTED 0x00000004
152 // The rest of the settings describe capabilities
154 #define EFI_RESOURCE_ATTRIBUTE_SINGLE_BIT_ECC 0x00000008
155 #define EFI_RESOURCE_ATTRIBUTE_MULTIPLE_BIT_ECC 0x00000010
156 #define EFI_RESOURCE_ATTRIBUTE_ECC_RESERVED_1 0x00000020
157 #define EFI_RESOURCE_ATTRIBUTE_ECC_RESERVED_2 0x00000040
158 #define EFI_RESOURCE_ATTRIBUTE_READ_PROTECTED 0x00000080
159 #define EFI_RESOURCE_ATTRIBUTE_WRITE_PROTECTED 0x00000100
160 #define EFI_RESOURCE_ATTRIBUTE_EXECUTION_PROTECTED 0x00000200
161 #define EFI_RESOURCE_ATTRIBUTE_UNCACHEABLE 0x00000400
162 #define EFI_RESOURCE_ATTRIBUTE_WRITE_COMBINEABLE 0x00000800
163 #define EFI_RESOURCE_ATTRIBUTE_WRITE_THROUGH_CACHEABLE 0x00001000
164 #define EFI_RESOURCE_ATTRIBUTE_WRITE_BACK_CACHEABLE 0x00002000
165 #define EFI_RESOURCE_ATTRIBUTE_16_BIT_IO 0x00004000
166 #define EFI_RESOURCE_ATTRIBUTE_32_BIT_IO 0x00008000
167 #define EFI_RESOURCE_ATTRIBUTE_64_BIT_IO 0x00010000
168 #define EFI_RESOURCE_ATTRIBUTE_UNCACHED_EXPORTED 0x00020000
171 // Describes the resource properties of all fixed,
172 // nonrelocatable resource ranges found on the processor
173 // host bus during the HOB producer phase.
176 EFI_HOB_GENERIC_HEADER Header
;
178 EFI_RESOURCE_TYPE ResourceType
;
179 EFI_RESOURCE_ATTRIBUTE_TYPE ResourceAttribute
;
180 EFI_PHYSICAL_ADDRESS PhysicalStart
;
181 UINT64 ResourceLength
;
182 } EFI_HOB_RESOURCE_DESCRIPTOR
;
185 // Allows writers of executable content in the HOB producer phase to
186 // maintain and manage HOBs with specific GUID.
189 EFI_HOB_GENERIC_HEADER Header
;
193 // Guid specific data goes here
198 // Details the location of firmware volumes that contain firmware files.
201 EFI_HOB_GENERIC_HEADER Header
;
202 EFI_PHYSICAL_ADDRESS BaseAddress
;
204 } EFI_HOB_FIRMWARE_VOLUME
;
207 // Details the location of a firmware volume which was extracted
208 // from a file within another firmware volume.
211 EFI_HOB_GENERIC_HEADER Header
;
212 EFI_PHYSICAL_ADDRESS BaseAddress
;
216 } EFI_HOB_FIRMWARE_VOLUME2
;
220 // Describes processor information, such as address space and I/O space capabilities.
223 EFI_HOB_GENERIC_HEADER Header
;
224 UINT8 SizeOfMemorySpace
;
231 // Describes pool memory allocations.
234 EFI_HOB_GENERIC_HEADER Header
;
235 } EFI_HOB_MEMORY_POOL
;
238 // Union of all the possible HOB Types
241 EFI_HOB_GENERIC_HEADER
*Header
;
242 EFI_HOB_HANDOFF_INFO_TABLE
*HandoffInformationTable
;
243 EFI_HOB_MEMORY_ALLOCATION
*MemoryAllocation
;
244 EFI_HOB_MEMORY_ALLOCATION_BSP_STORE
*MemoryAllocationBspStore
;
245 EFI_HOB_MEMORY_ALLOCATION_STACK
*MemoryAllocationStack
;
246 EFI_HOB_MEMORY_ALLOCATION_MODULE
*MemoryAllocationModule
;
247 EFI_HOB_RESOURCE_DESCRIPTOR
*ResourceDescriptor
;
248 EFI_HOB_GUID_TYPE
*Guid
;
249 EFI_HOB_FIRMWARE_VOLUME
*FirmwareVolume
;
250 EFI_HOB_FIRMWARE_VOLUME2
*FirmwareVolume2
;
252 EFI_HOB_MEMORY_POOL
*Pool
;
254 } EFI_PEI_HOB_POINTERS
;