]> git.proxmox.com Git - mirror_edk2.git/blame - EdkCompatibilityPkg/Foundation/Framework/Include/PeiHob.h
replaced EFI_HOB_TYPE_LOAD_PEIM with EFI_HOB_TYPE_LOAD_PEIM_UNUSED
[mirror_edk2.git] / EdkCompatibilityPkg / Foundation / Framework / Include / PeiHob.h
CommitLineData
3eb9473e 1/*++\r
2\r
3Copyright (c) 2004 - 2007, Intel Corporation \r
4All rights reserved. This program and the accompanying materials \r
5are licensed and made available under the terms and conditions of the BSD License \r
6which accompanies this distribution. The full text of the license may be found at \r
7http://opensource.org/licenses/bsd-license.php \r
8 \r
9THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
10WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
11\r
12Module Name:\r
13\r
14 PeiHob.h\r
15\r
16Abstract:\r
17\r
18 PEI Hand Off Block (HOB) definition.\r
19\r
20 The HOB is a memory data structure used to hand-off system information from\r
21 PEI to DXE (the next phase).\r
22\r
23--*/\r
24\r
25#ifndef _PEI_HOB_H_\r
26#define _PEI_HOB_H_\r
27\r
28#include "BootMode.h"\r
29\r
30//\r
31// Every Hob must start with this data structure.\r
32//\r
33typedef struct {\r
34 UINT16 HobType;\r
35 UINT16 HobLength;\r
36 UINT32 Reserved;\r
37} EFI_HOB_GENERIC_HEADER;\r
38\r
39//\r
40// End of HOB List HOB\r
41//\r
42#define EFI_HOB_TYPE_END_OF_HOB_LIST 0xffff\r
43\r
44//\r
45// Handoff Information Table HOB\r
46//\r
47#define EFI_HOB_TYPE_HANDOFF 0x0001\r
48\r
49#define EFI_HOB_HANDOFF_TABLE_VERSION 0x0009\r
50\r
51typedef UINT32 EFI_BOOT_MODE;\r
52\r
53typedef struct {\r
54 EFI_HOB_GENERIC_HEADER Header;\r
55 UINT32 Version;\r
56 EFI_BOOT_MODE BootMode;\r
57 EFI_PHYSICAL_ADDRESS EfiMemoryTop;\r
58 EFI_PHYSICAL_ADDRESS EfiMemoryBottom;\r
59 EFI_PHYSICAL_ADDRESS EfiFreeMemoryTop;\r
60 EFI_PHYSICAL_ADDRESS EfiFreeMemoryBottom;\r
61 EFI_PHYSICAL_ADDRESS EfiEndOfHobList;\r
62} EFI_HOB_HANDOFF_INFO_TABLE;\r
63\r
64//\r
65// Memory Descriptor HOB\r
66//\r
67#define EFI_HOB_TYPE_MEMORY_ALLOCATION 0x0002\r
68\r
69typedef struct {\r
70 EFI_GUID Name;\r
71 EFI_PHYSICAL_ADDRESS MemoryBaseAddress;\r
72 UINT64 MemoryLength;\r
73 EFI_MEMORY_TYPE MemoryType;\r
74 UINT8 Reserved[4];\r
75} EFI_HOB_MEMORY_ALLOCATION_HEADER;\r
76\r
77typedef struct {\r
78 EFI_HOB_GENERIC_HEADER Header;\r
79 EFI_HOB_MEMORY_ALLOCATION_HEADER AllocDescriptor;\r
80 //\r
81 // Additional data pertaining to the "Name" Guid memory\r
82 // may go here.\r
83 //\r
84} EFI_HOB_MEMORY_ALLOCATION;\r
85\r
86typedef struct {\r
87 EFI_HOB_GENERIC_HEADER Header;\r
88 EFI_HOB_MEMORY_ALLOCATION_HEADER AllocDescriptor;\r
89} EFI_HOB_MEMORY_ALLOCATION_BSP_STORE;\r
90\r
91typedef struct {\r
92 EFI_HOB_GENERIC_HEADER Header;\r
93 EFI_HOB_MEMORY_ALLOCATION_HEADER AllocDescriptor;\r
94} EFI_HOB_MEMORY_ALLOCATION_STACK;\r
95\r
96typedef struct {\r
97 EFI_HOB_GENERIC_HEADER Header;\r
98 EFI_HOB_MEMORY_ALLOCATION_HEADER MemoryAllocationHeader;\r
99 EFI_GUID ModuleName;\r
100 EFI_PHYSICAL_ADDRESS EntryPoint;\r
101} EFI_HOB_MEMORY_ALLOCATION_MODULE;\r
102\r
103#define EFI_HOB_TYPE_RESOURCE_DESCRIPTOR 0x0003\r
104\r
105typedef UINT32 EFI_RESOURCE_TYPE;\r
106\r
107#define EFI_RESOURCE_SYSTEM_MEMORY 0\r
108#define EFI_RESOURCE_MEMORY_MAPPED_IO 1\r
109#define EFI_RESOURCE_IO 2\r
110#define EFI_RESOURCE_FIRMWARE_DEVICE 3\r
111#define EFI_RESOURCE_MEMORY_MAPPED_IO_PORT 4\r
112#define EFI_RESOURCE_MEMORY_RESERVED 5\r
113#define EFI_RESOURCE_IO_RESERVED 6\r
114#define EFI_RESOURCE_MAX_MEMORY_TYPE 7\r
115\r
116typedef UINT32 EFI_RESOURCE_ATTRIBUTE_TYPE;\r
117\r
118#define EFI_RESOURCE_ATTRIBUTE_PRESENT 0x00000001\r
119#define EFI_RESOURCE_ATTRIBUTE_INITIALIZED 0x00000002\r
120#define EFI_RESOURCE_ATTRIBUTE_TESTED 0x00000004\r
121#define EFI_RESOURCE_ATTRIBUTE_SINGLE_BIT_ECC 0x00000008\r
122#define EFI_RESOURCE_ATTRIBUTE_MULTIPLE_BIT_ECC 0x00000010\r
123#define EFI_RESOURCE_ATTRIBUTE_ECC_RESERVED_1 0x00000020\r
124#define EFI_RESOURCE_ATTRIBUTE_ECC_RESERVED_2 0x00000040\r
125#define EFI_RESOURCE_ATTRIBUTE_READ_PROTECTED 0x00000080\r
126#define EFI_RESOURCE_ATTRIBUTE_WRITE_PROTECTED 0x00000100\r
127#define EFI_RESOURCE_ATTRIBUTE_EXECUTION_PROTECTED 0x00000200\r
128#define EFI_RESOURCE_ATTRIBUTE_UNCACHEABLE 0x00000400\r
129#define EFI_RESOURCE_ATTRIBUTE_WRITE_COMBINEABLE 0x00000800\r
130#define EFI_RESOURCE_ATTRIBUTE_WRITE_THROUGH_CACHEABLE 0x00001000\r
131#define EFI_RESOURCE_ATTRIBUTE_WRITE_BACK_CACHEABLE 0x00002000\r
132#define EFI_RESOURCE_ATTRIBUTE_16_BIT_IO 0x00004000\r
133#define EFI_RESOURCE_ATTRIBUTE_32_BIT_IO 0x00008000\r
134#define EFI_RESOURCE_ATTRIBUTE_64_BIT_IO 0x00010000\r
135#define EFI_RESOURCE_ATTRIBUTE_UNCACHED_EXPORTED 0x00020000\r
136\r
137typedef struct {\r
138 EFI_HOB_GENERIC_HEADER Header;\r
139 EFI_GUID Owner;\r
140 EFI_RESOURCE_TYPE ResourceType;\r
141 EFI_RESOURCE_ATTRIBUTE_TYPE ResourceAttribute;\r
142 EFI_PHYSICAL_ADDRESS PhysicalStart;\r
143 UINT64 ResourceLength;\r
144} EFI_HOB_RESOURCE_DESCRIPTOR;\r
145\r
146//\r
147// GUID Extension HOB\r
148// The HobLength is variable as it includes the GUID specific data.\r
149//\r
150#define EFI_HOB_TYPE_GUID_EXTENSION 0x0004\r
151\r
152typedef struct {\r
153 EFI_HOB_GENERIC_HEADER Header;\r
154 EFI_GUID Name;\r
155\r
156 //\r
157 // Guid specific data goes here\r
158 //\r
159} EFI_HOB_GUID_TYPE;\r
160\r
161//\r
162// Firmware Volume HOB\r
163//\r
164#define EFI_HOB_TYPE_FV 0x0005\r
165\r
166typedef struct {\r
167 EFI_HOB_GENERIC_HEADER Header;\r
168 EFI_PHYSICAL_ADDRESS BaseAddress;\r
169 UINT64 Length;\r
170} EFI_HOB_FIRMWARE_VOLUME;\r
171\r
172//\r
173// CPU HOB\r
174//\r
175#define EFI_HOB_TYPE_CPU 0x0006\r
176\r
177typedef struct {\r
178 EFI_HOB_GENERIC_HEADER Header;\r
179 UINT8 SizeOfMemorySpace;\r
180 UINT8 SizeOfIoSpace;\r
181 UINT8 Reserved[6];\r
182} EFI_HOB_CPU;\r
183\r
184//\r
185// PEI Core Memory Pool HOB\r
186// The HobLength is variable as the HOB contains pool allocations by\r
187// the PeiServices AllocatePool function\r
188//\r
189#define EFI_HOB_TYPE_PEI_MEMORY_POOL 0x0007\r
190\r
191typedef struct {\r
192 EFI_HOB_GENERIC_HEADER Header;\r
193} EFI_HOB_MEMORY_POOL;\r
194\r
195//\r
196// Capsule volume HOB -- identical to a firmware volume\r
197//\r
198#define EFI_HOB_TYPE_CV 0x0008\r
199\r
200typedef struct {\r
201 EFI_HOB_GENERIC_HEADER Header;\r
202 EFI_PHYSICAL_ADDRESS BaseAddress;\r
203 UINT64 Length;\r
204} EFI_HOB_CAPSULE_VOLUME;\r
205\r
206#if (PI_SPECIFICATION_VERSION >= 0x00010000)\r
207\r
208#define EFI_HOB_TYPE_FV2 0x0009\r
209\r
210typedef struct {\r
211 EFI_HOB_GENERIC_HEADER Header;\r
212 EFI_PHYSICAL_ADDRESS BaseAddress;\r
213 UINT64 Length;\r
214 EFI_GUID FvName;\r
215 EFI_GUID FileName;\r
216} EFI_HOB_FIRMWARE_VOLUME2;\r
217\r
5429e003 218#define EFI_HOB_TYPE_LOAD_PEIM_UNUSED 0x000A\r
3eb9473e 219\r
220#endif\r
221\r
222#define EFI_HOB_TYPE_UNUSED 0xFFFE\r
223\r
224//\r
225// Union of all the possible HOB Types\r
226//\r
227typedef union {\r
228 EFI_HOB_GENERIC_HEADER *Header;\r
229 EFI_HOB_HANDOFF_INFO_TABLE *HandoffInformationTable;\r
230 EFI_HOB_MEMORY_ALLOCATION *MemoryAllocation;\r
231 EFI_HOB_MEMORY_ALLOCATION_BSP_STORE *MemoryAllocationBspStore;\r
232 EFI_HOB_MEMORY_ALLOCATION_STACK *MemoryAllocationStack;\r
233 EFI_HOB_MEMORY_ALLOCATION_MODULE *MemoryAllocationModule;\r
234 EFI_HOB_RESOURCE_DESCRIPTOR *ResourceDescriptor;\r
235 EFI_HOB_GUID_TYPE *Guid;\r
236 EFI_HOB_FIRMWARE_VOLUME *FirmwareVolume;\r
237#if (PI_SPECIFICATION_VERSION >= 0x00010000)\r
238 EFI_HOB_FIRMWARE_VOLUME2 *FirmwareVolume2;\r
239#endif\r
240 EFI_HOB_CPU *Cpu;\r
241 EFI_HOB_MEMORY_POOL *Pool;\r
242 EFI_HOB_CAPSULE_VOLUME *CapsuleVolume;\r
243 UINT8 *Raw;\r
244} EFI_PEI_HOB_POINTERS;\r
245\r
246#define GET_HOB_TYPE(Hob) ((Hob).Header->HobType)\r
247#define GET_HOB_LENGTH(Hob) ((Hob).Header->HobLength)\r
248#define GET_NEXT_HOB(Hob) ((Hob).Raw + GET_HOB_LENGTH (Hob))\r
249#define END_OF_HOB_LIST(Hob) (GET_HOB_TYPE (Hob) == EFI_HOB_TYPE_END_OF_HOB_LIST)\r
250\r
251#endif\r