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