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