1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
|
/*++
Copyright (c) 2004, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Module Name:
PeiHobLib.h
Abstract:
--*/
#ifndef _EFI_PEI_HOB_LIB_H_
#define _EFI_PEI_HOB_LIB_H_
#include "PeiApi.h" // EFI_PEI_SERVICES definition
#define EFI_STACK_SIZE 0x20000
#define EFI_BSP_STORE_SIZE 0x4000
EFI_STATUS
BuildHobHandoffInfoTable (
IN VOID *HobStart,
IN UINT16 Version,
IN EFI_BOOT_MODE BootMode,
IN EFI_PHYSICAL_ADDRESS EfiMemoryTop,
IN EFI_PHYSICAL_ADDRESS EfiMemoryBottom,
IN EFI_PHYSICAL_ADDRESS EfiFreeMemoryTop,
IN EFI_PHYSICAL_ADDRESS EfiFreeMemoryBottom
)
/*++
Routine Description:
Builds a HandoffInformationTable Information Table HOB
Arguments:
HobStart - Start pointer of hob list
Version - The version number pertaining to the PHIT HOB definition.
BootMode - The system boot mode as determined during the HOB producer phase.
EfiMemoryTop - The highest address location of memory that is allocated for use by the HOB
producer phase.
EfiMemoryBottom - The lowest address location of memory that is allocated for use by the HOB
producer phase.
EfiFreeMemoryTop - The highest address location of free memory that is currently available for use
by the HOB producer phase.
EfiFreeMemoryBottom - The lowest address location of free memory that is available for
use by the HOB producer phase.
Returns:
EFI_SUCCESS
--*/
;
EFI_STATUS
BuildHobModule (
IN VOID *HobStart,
IN EFI_GUID *ModuleName,
IN EFI_PHYSICAL_ADDRESS Module,
IN UINT64 ModuleLength,
IN EFI_PHYSICAL_ADDRESS EntryPoint
)
/*++
Routine Description:
Builds a HOB for a loaded PE32 module
Arguments:
HobStart - Start pointer of hob list
ModuleName - The GUID File Name of the HON from the Firmware Volume
Module - The 64 bit physical address of the module
ModuleLength - The length of the module in bytes
EntryPoint - The 64 bit physical address of the entry point to the module
Returns:
EFI_SUCCESS
EFI_NOT_AVAILABLE_YET
--*/
;
EFI_STATUS
BuildHobResourceDescriptor (
IN VOID *HobStart,
IN EFI_RESOURCE_TYPE ResourceType,
IN EFI_RESOURCE_ATTRIBUTE_TYPE ResourceAttribute,
IN EFI_PHYSICAL_ADDRESS PhysicalStart,
IN UINT64 NumberOfBytes
)
/*++
Routine Description:
Builds a HOB that describes a chunck of system memory
Arguments:
HobStart - Start pointer of hob list
ResourceType - The type of memory described by this HOB
ResourceAttribute - The memory attributes of the memory described by this HOB
PhysicalStart - The 64 bit physical address of memory described by this HOB
NumberOfBytes - The length of the memoty described by this HOB in bytes
Returns:
EFI_SUCCESS
EFI_NOT_AVAILABLE_YET
--*/
;
EFI_STATUS
BuildHobGuidType (
IN VOID *HobStart,
IN EFI_GUID *Guid,
IN VOID *Buffer,
IN UINTN BufferSize
)
/*++
Routine Description:
Builds a custom HOB that is tagged with a GUID for identification
Arguments:
HobStart - Start pointer of hob list
Guid - The GUID of the custome HOB type
Buffer - A pointer to the data for the custom HOB type
BufferSize - The size in byte of BufferSize
Returns:
EFI_SUCCESS
EFI_NOT_AVAILABLE_YET
--*/
;
EFI_STATUS
BuildHobFvDescriptor (
IN VOID *HobStart,
IN EFI_PHYSICAL_ADDRESS BaseAddress,
IN UINT64 Length
)
/*++
Routine Description:
Builds a Firmware Volume HOB
Arguments:
HobStart - Start pointer of hob list
BaseAddress - The base address of the Firmware Volume
Length - The size of the Firmware Volume in bytes
Returns:
EFI_SUCCESS
EFI_NOT_AVAILABLE_YET
--*/
;
EFI_STATUS
BuildHobCpu (
IN VOID *HobStart,
IN UINT8 SizeOfMemorySpace,
IN UINT8 SizeOfIoSpace
)
/*++
Routine Description:
Builds a HOB for the CPU
Arguments:
HobStart - Start pointer of hob list
SizeOfMemorySpace - Identifies the maximum
physical memory addressibility of the processor.
SizeOfIoSpace - Identifies the maximum physical I/O addressibility
of the processor.
Returns:
EFI_SUCCESS
EFI_NOT_AVAILABLE_YET
--*/
;
EFI_STATUS
BuildHobStack (
IN VOID *HobStart,
IN EFI_PHYSICAL_ADDRESS BaseAddress,
IN UINT64 Length
)
/*++
Routine Description:
Builds a HOB for the Stack
Arguments:
HobStart - Start pointer of hob list
BaseAddress - The 64 bit physical address of the Stack
Length - The length of the stack in bytes
Returns:
EFI_SUCCESS
EFI_NOT_AVAILABLE_YET
--*/
;
EFI_STATUS
BuildHobBspStore (
IN VOID *HobStart,
IN EFI_PHYSICAL_ADDRESS BaseAddress,
IN UINT64 Length,
IN EFI_MEMORY_TYPE MemoryType
)
/*++
Routine Description:
Builds a HOB for the bsp store
Arguments:
HobStart - Start pointer of hob list
BaseAddress - The 64 bit physical address of bsp store
Length - The length of the bsp store in bytes
MemoryType - Memory type of the bsp store
Returns:
EFI_SUCCESS
EFI_NOT_AVAILABLE_YET
--*/
;
EFI_STATUS
BuildMemoryAllocationHob (
IN VOID *HobStart,
IN EFI_PHYSICAL_ADDRESS BaseAddress,
IN UINT64 Length,
IN EFI_GUID *Name,
IN EFI_MEMORY_TYPE MemoryType
)
/*++
Routine Description:
Builds a HOB for memory allocation
Arguments:
HobStart - Start pointer of hob list
BaseAddress - The base address of memory allocated by this HOB.
Length - The length in bytes of memory allocated by this HOB.
Name - A GUID that defines the memory allocation region¡¯s type and purpose,
as well as other fields within the memory allocation HOB.
MemoryType - Defines the type of memory allocated by this HOB.
Returns:
EFI_SUCCESS
EFI_NOT_AVAILABLE_YET
--*/
;
EFI_STATUS
GetNextGuidHob (
IN OUT VOID **HobStart,
IN EFI_GUID * Guid,
OUT VOID **Buffer,
OUT UINTN *BufferSize OPTIONAL
)
/*++
Routine Description:
Get the next guid hob.
Arguments:
HobStart A pointer to the start hob.
Guid A pointer to a guid.
Buffer A pointer to the buffer.
BufferSize Buffer size.
Returns:
Status code.
EFI_NOT_FOUND - Next Guid hob not found
EFI_SUCCESS - Next Guid hob found and data for this Guid got
EFI_INVALID_PARAMETER - invalid parameter
--*/
;
#endif
|
