]>
Commit | Line | Data |
---|---|---|
959ccb23 | 1 | /** @file\r |
2 | PI PEI master include file. This file should match the PI spec.\r | |
3 | \r | |
4 | Copyright (c) 2006 - 2007, Intel Corporation \r | |
5 | All rights reserved. This program and the accompanying materials \r | |
6 | are licensed and made available under the terms and conditions of the BSD License \r | |
7 | which accompanies this distribution. The full text of the license may be found at \r | |
8 | http://opensource.org/licenses/bsd-license.php \r | |
9 | \r | |
10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r | |
11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r | |
12 | \r | |
959ccb23 | 13 | @par Revision Reference:\r |
14 | Version 1.0.\r | |
15 | \r | |
16 | **/\r | |
17 | \r | |
18 | #ifndef __PI_PEICIS_H__\r | |
19 | #define __PI_PEICIS_H__\r | |
20 | \r | |
21 | #include <Pi/PiMultiPhase.h>\r | |
22 | \r | |
6de794cd | 23 | ///\r |
24 | /// Handles of EFI FV.\r | |
25 | /// \r | |
00edb218 | 26 | typedef VOID *EFI_PEI_FV_HANDLE;\r |
6de794cd | 27 | \r |
28 | ///\r | |
29 | /// Handles of EFI FFS\r | |
30 | /// \r | |
00edb218 | 31 | typedef VOID *EFI_PEI_FILE_HANDLE;\r |
959ccb23 | 32 | \r |
6de794cd | 33 | ///\r |
34 | /// Declare forward reference data structure for EFI_PEI_SERVICE\r | |
35 | /// \r | |
959ccb23 | 36 | typedef struct _EFI_PEI_SERVICES EFI_PEI_SERVICES;\r |
6de794cd | 37 | \r |
38 | ///\r | |
39 | /// Declare forward reference data structure for EFI_PEI_NOTIFY_DESCRIPTOR\r | |
40 | /// \r | |
959ccb23 | 41 | typedef struct _EFI_PEI_NOTIFY_DESCRIPTOR EFI_PEI_NOTIFY_DESCRIPTOR;\r |
42 | \r | |
43 | \r | |
44 | #include <Ppi/CpuIo.h>\r | |
45 | #include <Ppi/PciCfg2.h>\r | |
46 | \r | |
fb3df220 | 47 | \r |
959ccb23 | 48 | /**\r |
49 | The PEI Dispatcher will invoke each PEIM one time. During this pass, the PEI \r | |
50 | Dispatcher will pass control to the PEIM at the AddressOfEntryPoint in the PE Header. \r | |
51 | \r | |
6de794cd | 52 | @param FileHandle Pointer to the FFS file header.\r |
959ccb23 | 53 | @param PeiServices Describes the list of possible PEI Services.\r |
54 | \r | |
373b5cf9 | 55 | @retval EFI_SUCCESS The PEI completed successfully.\r |
56 | @retval !EFI_SUCCESS There is error in PEIM.\r | |
959ccb23 | 57 | \r |
58 | **/\r | |
59 | typedef\r | |
60 | EFI_STATUS\r | |
1c9d209f | 61 | (EFIAPI *EFI_PEIM_ENTRY_POINT2)(\r |
b0d803fe | 62 | IN EFI_PEI_FILE_HANDLE FileHandle,\r |
63 | IN CONST EFI_PEI_SERVICES **PeiServices\r | |
959ccb23 | 64 | );\r |
65 | \r | |
66 | /**\r | |
67 | Entry point of the notification callback function itself within the PEIM.\r | |
68 | \r | |
69 | @param PeiServices Indirect reference to the PEI Services Table.\r | |
70 | @param NotifyDescriptor Address of the notification descriptor data structure.\r | |
71 | @param Ppi Address of the PPI that was installed.\r | |
72 | \r | |
373b5cf9 | 73 | @return Status of the notification.\r |
959ccb23 | 74 | **/\r |
75 | typedef\r | |
76 | EFI_STATUS\r | |
6de794cd | 77 | (EFIAPI *EFI_PEIM_NOTIFY_ENTRY_POINT)(\r |
959ccb23 | 78 | IN EFI_PEI_SERVICES **PeiServices,\r |
79 | IN EFI_PEI_NOTIFY_DESCRIPTOR *NotifyDescriptor,\r | |
80 | IN VOID *Ppi\r | |
81 | );\r | |
82 | \r | |
83 | //\r | |
84 | // PEI Ppi Services List Descriptors\r | |
85 | //\r | |
86 | #define EFI_PEI_PPI_DESCRIPTOR_PIC 0x00000001\r | |
87 | #define EFI_PEI_PPI_DESCRIPTOR_PPI 0x00000010\r | |
88 | #define EFI_PEI_PPI_DESCRIPTOR_NOTIFY_CALLBACK 0x00000020\r | |
89 | #define EFI_PEI_PPI_DESCRIPTOR_NOTIFY_DISPATCH 0x00000040\r | |
90 | #define EFI_PEI_PPI_DESCRIPTOR_NOTIFY_TYPES 0x00000060\r | |
91 | #define EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST 0x80000000\r | |
92 | \r | |
6de794cd | 93 | ///\r |
94 | /// The data structure through which a PEIM describes available services to the PEI Foundation.\r | |
95 | /// \r | |
959ccb23 | 96 | typedef struct {\r |
97 | UINTN Flags;\r | |
98 | EFI_GUID *Guid;\r | |
99 | VOID *Ppi;\r | |
100 | } EFI_PEI_PPI_DESCRIPTOR;\r | |
101 | \r | |
6de794cd | 102 | /// \r |
103 | /// The data structure in a given PEIM that tells the PEI \r | |
104 | /// Foundation where to invoke the notification service.\r | |
105 | /// \r | |
959ccb23 | 106 | struct _EFI_PEI_NOTIFY_DESCRIPTOR {\r |
107 | UINTN Flags;\r | |
108 | EFI_GUID *Guid;\r | |
109 | EFI_PEIM_NOTIFY_ENTRY_POINT Notify;\r | |
110 | };\r | |
111 | \r | |
6de794cd | 112 | ///\r |
113 | /// Describes request of the module to be loaded to \r | |
114 | /// the permanent memory once it is available. Unlike most of the other HOBs, \r | |
115 | /// this HOB is produced and consumed during the HOB producer phase.\r | |
116 | /// \r | |
959ccb23 | 117 | typedef struct _EFI_HOB_LOAD_PEIM {\r |
00edb218 A |
118 | EFI_HOB_GENERIC_HEADER Header;\r |
119 | EFI_PEI_FILE_HANDLE FileHandle;\r | |
1c9d209f | 120 | EFI_PEIM_ENTRY_POINT2 EntryPoint;\r |
121 | EFI_PEIM_ENTRY_POINT2 InMemEntryPoint;\r | |
959ccb23 | 122 | } EFI_HOB_LOAD_PEIM;\r |
123 | \r | |
124 | \r | |
125 | /**\r | |
126 | This service is the first one provided by the PEI Foundation. This function \r | |
127 | installs an interface in the PEI PPI database by GUID. The purpose of the \r | |
128 | service is to publish an interface that other parties can use to call \r | |
129 | additional PEIMs.\r | |
130 | \r | |
131 | @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table\r | |
132 | published by the PEI Foundation.\r | |
133 | @param PpiList A pointer to the list of interfaces that the caller shall install.\r | |
134 | \r | |
135 | @retval EFI_SUCCESS The interface was successfully installed.\r | |
136 | @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL or Any of the PEI PPI descriptors in the list do not have the EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field.\r | |
137 | @retval EFI_OUT_OF_RESOURCES There is no additional space in the PPI database.\r | |
138 | \r | |
139 | **/\r | |
140 | typedef\r | |
141 | EFI_STATUS\r | |
6de794cd | 142 | (EFIAPI *EFI_PEI_INSTALL_PPI)(\r |
1c280088 | 143 | IN CONST EFI_PEI_SERVICES **PeiServices,\r |
144 | IN CONST EFI_PEI_PPI_DESCRIPTOR *PpiList\r | |
959ccb23 | 145 | );\r |
146 | \r | |
147 | /**\r | |
148 | This function reinstalls an interface in the PEI PPI database by GUID. \r | |
149 | The purpose of the service is to publish an interface that other parties \r | |
150 | can use to replace a same-named interface in the protocol database \r | |
151 | with a different interface. \r | |
152 | \r | |
153 | @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table\r | |
154 | published by the PEI Foundation.\r | |
155 | @param OldPpi A pointer to the former PPI in the database.\r | |
156 | @param NewPpi A pointer to the new interfaces that the caller shall install.\r | |
157 | \r | |
158 | @retval EFI_SUCCESS The interface was successfully installed.\r | |
159 | @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL or Any of the PEI PPI descriptors in the \r | |
160 | list do not have the EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field.\r | |
161 | @retval EFI_OUT_OF_RESOURCES There is no additional space in the PPI database.\r | |
162 | @retval EFI_NOT_FOUND The PPI for which the reinstallation was requested has not been installed.\r | |
163 | \r | |
164 | **/\r | |
165 | typedef\r | |
166 | EFI_STATUS\r | |
6de794cd | 167 | (EFIAPI *EFI_PEI_REINSTALL_PPI)(\r |
1c280088 | 168 | IN CONST EFI_PEI_SERVICES **PeiServices,\r |
169 | IN CONST EFI_PEI_PPI_DESCRIPTOR *OldPpi,\r | |
170 | IN CONST EFI_PEI_PPI_DESCRIPTOR *NewPpi\r | |
959ccb23 | 171 | );\r |
172 | \r | |
173 | /**\r | |
174 | This function locates an interface in the PEI PPI database by GUID. \r | |
175 | \r | |
176 | @param PeiServices An indirect pointer to the EFI_PEI_SERVICES published by the PEI Foundation.\r | |
177 | @param Guid A pointer to the GUID whose corresponding interface needs to be found.\r | |
178 | @param Instance The N-th instance of the interface that is required.\r | |
179 | @param PpiDescriptor A pointer to instance of the EFI_PEI_PPI_DESCRIPTOR.\r | |
180 | @param Ppi A pointer to the instance of the interface.\r | |
181 | \r | |
182 | @retval EFI_SUCCESS The interface was successfully returned.\r | |
183 | @retval EFI_NOT_FOUND The PPI descriptor is not found in the database.\r | |
184 | \r | |
185 | **/\r | |
186 | typedef\r | |
187 | EFI_STATUS\r | |
6de794cd | 188 | (EFIAPI *EFI_PEI_LOCATE_PPI)(\r |
1c280088 | 189 | IN CONST EFI_PEI_SERVICES **PeiServices,\r |
190 | IN CONST EFI_GUID *Guid,\r | |
191 | IN UINTN Instance,\r | |
192 | IN OUT EFI_PEI_PPI_DESCRIPTOR **PpiDescriptor OPTIONAL,\r | |
193 | IN OUT VOID **Ppi\r | |
959ccb23 | 194 | );\r |
195 | \r | |
196 | /**\r | |
197 | This function installs a notification service to be called back when a \r | |
198 | given interface is installed or reinstalled. The purpose of the service \r | |
199 | is to publish an interface that other parties can use to call additional PPIs \r | |
200 | that may materialize later.\r | |
201 | \r | |
202 | @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation\r | |
203 | @param NotifyList A pointer to the list of notification interfaces that the caller shall install.\r | |
204 | \r | |
205 | @retval EFI_SUCCESS The interface was successfully installed.\r | |
206 | @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL or Any of the PEI PPI descriptors in the \r | |
207 | list do not have the EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field.\r | |
208 | @retval EFI_OUT_OF_RESOURCES There is no additional space in the PPI database.\r | |
209 | \r | |
210 | **/\r | |
211 | typedef\r | |
212 | EFI_STATUS\r | |
6de794cd | 213 | (EFIAPI *EFI_PEI_NOTIFY_PPI)(\r |
1c280088 | 214 | IN CONST EFI_PEI_SERVICES **PeiServices,\r |
215 | IN CONST EFI_PEI_NOTIFY_DESCRIPTOR *NotifyList\r | |
959ccb23 | 216 | );\r |
217 | \r | |
218 | /**\r | |
219 | This function returns the present value of the boot mode.\r | |
220 | \r | |
221 | @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r | |
222 | @param BootMode A pointer to contain the value of the boot mode.\r | |
223 | \r | |
224 | @retval EFI_SUCCESS The boot mode was returned successfully.\r | |
225 | \r | |
226 | **/\r | |
227 | typedef\r | |
228 | EFI_STATUS\r | |
6de794cd | 229 | (EFIAPI *EFI_PEI_GET_BOOT_MODE)(\r |
1c280088 | 230 | IN CONST EFI_PEI_SERVICES **PeiServices,\r |
231 | OUT EFI_BOOT_MODE *BootMode\r | |
959ccb23 | 232 | );\r |
233 | \r | |
234 | /**\r | |
235 | This function sets the value of the boot mode.\r | |
236 | \r | |
237 | @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation\r | |
238 | @param BootMode The value of the boot mode to set.\r | |
239 | \r | |
240 | @retval EFI_SUCCESS The boot mode was returned successfully.\r | |
241 | \r | |
242 | **/\r | |
243 | typedef\r | |
244 | EFI_STATUS\r | |
6de794cd | 245 | (EFIAPI *EFI_PEI_SET_BOOT_MODE)(\r |
1c280088 | 246 | IN CONST EFI_PEI_SERVICES **PeiServices,\r |
247 | IN EFI_BOOT_MODE BootMode\r | |
959ccb23 | 248 | );\r |
249 | \r | |
250 | /**\r | |
251 | This function returns the pointer to the list of Hand-Off Blocks (HOBs) in memory. \r | |
252 | \r | |
253 | @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation\r | |
254 | @param HobList A pointer to the list of HOBs that the PEI Foundation will initialize\r | |
255 | \r | |
256 | @retval EFI_SUCCESS The list was successfully returned.\r | |
257 | @retval EFI_NOT_AVAILABLE_YET The HOB list is not yet published.\r | |
258 | \r | |
259 | **/\r | |
260 | typedef\r | |
261 | EFI_STATUS\r | |
6de794cd | 262 | (EFIAPI *EFI_PEI_GET_HOB_LIST)(\r |
1c280088 | 263 | IN CONST EFI_PEI_SERVICES **PeiServices,\r |
67c89a21 | 264 | OUT VOID **HobList\r |
959ccb23 | 265 | );\r |
266 | \r | |
267 | /**\r | |
268 | This service published by the PEI Foundation abstracts the creation of a Hand-Off Block's (HOB's) headers.\r | |
269 | \r | |
270 | @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r | |
271 | @param Type The type of HOB to be installed.\r | |
272 | @param Length The length of the HOB to be added.\r | |
273 | @param Hob The address of a pointer that will contain the HOB header.\r | |
274 | \r | |
275 | @retval EFI_SUCCESS The HOB was successfully created.\r | |
276 | @retval EFI_OUT_OF_RESOURCES There is no additional space for HOB creation.\r | |
277 | \r | |
278 | **/\r | |
279 | typedef\r | |
280 | EFI_STATUS\r | |
6de794cd | 281 | (EFIAPI *EFI_PEI_CREATE_HOB)(\r |
1c280088 | 282 | IN CONST EFI_PEI_SERVICES **PeiServices,\r |
283 | IN UINT16 Type,\r | |
284 | IN UINT16 Length,\r | |
67c89a21 | 285 | OUT VOID **Hob\r |
959ccb23 | 286 | );\r |
287 | \r | |
288 | /**\r | |
289 | The purpose of the service is to abstract the capability of the PEI \r | |
290 | Foundation to discover instances of firmware volumes in the system. \r | |
291 | Given the input file pointer, this service searches for the next \r | |
292 | matching file in the Firmware File System (FFS) volume.\r | |
293 | \r | |
294 | @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r | |
295 | @param Instance This instance of the firmware volume to find. The value 0 is the Boot Firmware Volume (BFV).\r | |
1c280088 | 296 | @param VolumeHandle On exit, points to the next volumn handle or NULL if it does not exist.\r |
959ccb23 | 297 | \r |
298 | @retval EFI_SUCCESS The volume was found.\r | |
299 | @retval EFI_NOT_FOUND The volume was not found.\r | |
1c280088 | 300 | @retval EFI_INVALID_PARAMETER VolHandle is NULL\r |
959ccb23 | 301 | \r |
302 | **/\r | |
303 | typedef\r | |
304 | EFI_STATUS\r | |
6de794cd | 305 | (EFIAPI *EFI_PEI_FFS_FIND_NEXT_VOLUME2)(\r |
1c280088 | 306 | IN CONST EFI_PEI_SERVICES **PeiServices,\r |
307 | IN UINTN Instance,\r | |
308 | OUT EFI_PEI_FV_HANDLE *VolumeHandle\r | |
959ccb23 | 309 | );\r |
310 | \r | |
311 | /**\r | |
312 | The purpose of the service is to abstract the capability of the PEI \r | |
313 | Foundation to discover instances of firmware files in the system. \r | |
314 | Given the input file pointer, this service searches for the next matching \r | |
315 | file in the Firmware File System (FFS) volume.\r | |
316 | \r | |
317 | @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r | |
318 | @param SearchType A filter to find files only of this type.\r | |
319 | @param FwVolHeader Pointer to the firmware volume header of the volume to search.This parameter \r | |
320 | must point to a valid FFS volume.\r | |
321 | @param FileHeader Pointer to the current file from which to begin searching.This pointer will be \r | |
322 | updated upon return to reflect the file found.\r | |
323 | \r | |
324 | @retval EFI_SUCCESS The file was found.\r | |
325 | @retval EFI_NOT_FOUND The file was not found.\r | |
326 | @retval EFI_NOT_FOUND The header checksum was not zero.\r | |
327 | \r | |
328 | **/\r | |
329 | typedef\r | |
330 | EFI_STATUS\r | |
6de794cd | 331 | (EFIAPI *EFI_PEI_FFS_FIND_NEXT_FILE2)(\r |
1c280088 | 332 | IN CONST EFI_PEI_SERVICES **PeiServices,\r |
333 | IN EFI_FV_FILETYPE SearchType,\r | |
334 | IN EFI_PEI_FV_HANDLE VolumeHandle,\r | |
335 | IN OUT EFI_PEI_FILE_HANDLE *FileHandle\r | |
959ccb23 | 336 | );\r |
337 | \r | |
338 | /**\r | |
339 | Given the input file pointer, this service searches for the next \r | |
340 | matching file in the Firmware File System (FFS) volume. \r | |
341 | \r | |
342 | @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r | |
343 | @param SectionType The value of the section type to find.\r | |
344 | @param FfsFileHeader A pointer to the file header that contains the set of sections to be searched.\r | |
345 | @param SectionData A pointer to the discovered section, if successful.\r | |
346 | \r | |
347 | @retval EFI_SUCCESS The section was found.\r | |
348 | @retval EFI_NOT_FOUND The section was not found.\r | |
349 | \r | |
350 | **/\r | |
351 | typedef\r | |
352 | EFI_STATUS\r | |
6de794cd | 353 | (EFIAPI *EFI_PEI_FFS_FIND_SECTION_DATA2)(\r |
1c280088 | 354 | IN CONST EFI_PEI_SERVICES **PeiServices,\r |
355 | IN EFI_SECTION_TYPE SectionType,\r | |
356 | IN EFI_PEI_FILE_HANDLE FileHandle,\r | |
357 | IN OUT VOID **SectionData\r | |
959ccb23 | 358 | );\r |
359 | \r | |
360 | /**\r | |
361 | This function registers the found memory configuration with the PEI Foundation.\r | |
362 | \r | |
363 | @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r | |
364 | @param MemoryBegin The value of a region of installed memory\r | |
365 | @param MemoryLength The corresponding length of a region of installed memory.\r | |
366 | \r | |
367 | @retval EFI_SUCCESS The region was successfully installed in a HOB.\r | |
368 | @retval EFI_INVALID_PARAMETER MemoryBegin and MemoryLength are illegal for this system.\r | |
369 | @retval EFI_OUT_OF_RESOURCES There is no additional space for HOB creation.\r | |
370 | \r | |
371 | **/\r | |
372 | typedef\r | |
373 | EFI_STATUS\r | |
6de794cd | 374 | (EFIAPI *EFI_PEI_INSTALL_PEI_MEMORY)(\r |
1c280088 | 375 | IN CONST EFI_PEI_SERVICES **PeiServices,\r |
959ccb23 | 376 | IN EFI_PHYSICAL_ADDRESS MemoryBegin,\r |
377 | IN UINT64 MemoryLength\r | |
378 | );\r | |
379 | \r | |
380 | /**\r | |
381 | The purpose of the service is to publish an interface that allows \r | |
382 | PEIMs to allocate memory ranges that are managed by the PEI Foundation.\r | |
383 | \r | |
384 | @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r | |
385 | @param MemoryType The type of memory to allocate.\r | |
386 | @param Pages The number of contiguous 4 KB pages to allocate.\r | |
387 | @param Memory Pointer to a physical address. On output, the address is set to the base \r | |
388 | of the page range that was allocated.\r | |
389 | \r | |
390 | @retval EFI_SUCCESS The memory range was successfully allocated.\r | |
391 | @retval EFI_OUT_OF_RESOURCES The pages could not be allocated.\r | |
392 | @retval EFI_INVALID_PARAMETER Type is not equal to AllocateAnyPages.\r | |
393 | \r | |
394 | **/\r | |
395 | typedef\r | |
396 | EFI_STATUS\r | |
6de794cd | 397 | (EFIAPI *EFI_PEI_ALLOCATE_PAGES)(\r |
1c280088 | 398 | IN CONST EFI_PEI_SERVICES **PeiServices,\r |
959ccb23 | 399 | IN EFI_MEMORY_TYPE MemoryType,\r |
400 | IN UINTN Pages,\r | |
401 | IN OUT EFI_PHYSICAL_ADDRESS *Memory\r | |
402 | );\r | |
403 | \r | |
404 | /**\r | |
405 | The purpose of this service is to publish an interface that \r | |
406 | allows PEIMs to allocate memory ranges that are managed by the PEI Foundation.\r | |
407 | \r | |
408 | @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r | |
409 | @param Size The number of bytes to allocate from the pool.\r | |
410 | @param Buffer If the call succeeds, a pointer to a pointer to the allocated buffer; undefined otherwise.\r | |
411 | \r | |
412 | @retval EFI_SUCCESS The allocation was successful.\r | |
413 | @retval EFI_OUT_OF_RESOURCES There is not enough heap to allocate the requested size.\r | |
414 | \r | |
415 | **/\r | |
416 | typedef\r | |
417 | EFI_STATUS\r | |
6de794cd | 418 | (EFIAPI *EFI_PEI_ALLOCATE_POOL)(\r |
1c280088 | 419 | IN CONST EFI_PEI_SERVICES **PeiServices,\r |
959ccb23 | 420 | IN UINTN Size,\r |
421 | OUT VOID **Buffer\r | |
422 | );\r | |
423 | \r | |
424 | /**\r | |
425 | This service copies the contents of one buffer to another buffer.\r | |
426 | \r | |
427 | @param Destination Pointer to the destination buffer of the memory copy.\r | |
428 | @param Source Pointer to the source buffer of the memory copy\r | |
429 | @param Length Number of bytes to copy from Source to Destination.\r | |
430 | \r | |
959ccb23 | 431 | **/\r |
432 | typedef\r | |
433 | VOID\r | |
6de794cd | 434 | (EFIAPI *EFI_PEI_COPY_MEM)(\r |
959ccb23 | 435 | IN VOID *Destination,\r |
436 | IN VOID *Source,\r | |
437 | IN UINTN Length\r | |
438 | );\r | |
439 | \r | |
440 | /**\r | |
441 | The service fills a buffer with a specified value.\r | |
442 | \r | |
443 | @param Buffer Pointer to the buffer to fill.\r | |
444 | @param Size Number of bytes in Buffer to fill.\r | |
445 | @param Value Value to fill Buffer with\r | |
446 | \r | |
959ccb23 | 447 | **/\r |
448 | typedef\r | |
449 | VOID\r | |
6de794cd | 450 | (EFIAPI *EFI_PEI_SET_MEM)(\r |
959ccb23 | 451 | IN VOID *Buffer,\r |
452 | IN UINTN Size,\r | |
453 | IN UINT8 Value\r | |
454 | );\r | |
455 | \r | |
456 | /**\r | |
457 | This service publishes an interface that allows PEIMs to report status codes.\r | |
458 | \r | |
459 | @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r | |
460 | @param Type Indicates the type of status code being reported.\r | |
461 | @param Value Describes the current status of a hardware or\r | |
462 | software entity. This includes information about the class and\r | |
463 | subclass that is used to classify the entity as well as an operation.\r | |
464 | For progress codes, the operation is the current activity.\r | |
465 | For error codes, it is the exception.For debug codes,it is not defined at this time.\r | |
466 | @param Instance The enumeration of a hardware or software entity within\r | |
467 | the system. A system may contain multiple entities that match a class/subclass\r | |
468 | pairing. The instance differentiates between them. An instance of 0 indicates\r | |
469 | that instance information is unavailable, not meaningful, or not relevant.\r | |
470 | Valid instance numbers start with 1.\r | |
471 | @param CallerId This optional parameter may be used to identify the caller.\r | |
472 | This parameter allows the status code driver to apply different rules to\r | |
473 | different callers.\r | |
474 | @param Data This optional parameter may be used to pass additional data.\r | |
475 | \r | |
476 | @retval EFI_SUCCESS The function completed successfully.\r | |
477 | @retval EFI_NOT_AVAILABLE_YET No progress code provider has installed an interface in the system.\r | |
478 | \r | |
479 | **/\r | |
480 | typedef\r | |
481 | EFI_STATUS\r | |
6de794cd | 482 | (EFIAPI *EFI_PEI_REPORT_STATUS_CODE)(\r |
1c280088 | 483 | IN CONST EFI_PEI_SERVICES **PeiServices,\r |
484 | IN EFI_STATUS_CODE_TYPE Type,\r | |
485 | IN EFI_STATUS_CODE_VALUE Value,\r | |
486 | IN UINT32 Instance,\r | |
487 | IN CONST EFI_GUID *CallerId OPTIONAL,\r | |
488 | IN CONST EFI_STATUS_CODE_DATA *Data OPTIONAL\r | |
959ccb23 | 489 | );\r |
490 | \r | |
491 | /**\r | |
492 | Resets the entire platform.\r | |
493 | \r | |
494 | @param PeiServices An indirect pointer to the EFI_PEI_SERVICES\r | |
495 | table published by the PEI Foundation.\r | |
496 | \r | |
497 | @retval EFI_SUCCESS The function completed successfully.\r | |
498 | @retval EFI_NOT_AVAILABLE_YET The service has not been installed yet.\r | |
499 | \r | |
500 | **/\r | |
501 | typedef\r | |
502 | EFI_STATUS\r | |
6de794cd | 503 | (EFIAPI *EFI_PEI_RESET_SYSTEM)(\r |
b0d803fe | 504 | IN CONST EFI_PEI_SERVICES **PeiServices\r |
959ccb23 | 505 | );\r |
506 | \r | |
507 | /**\r | |
508 | \r | |
00edb218 A |
509 | This service searches for files with a specific name, within\r |
510 | either the specified firmware volume or all firmware volumes.\r | |
511 | The service returns a file handle of type EFI_PEI_FILE_HANDLE,\r | |
959ccb23 | 512 | which must be unique within the system.\r |
513 | \r | |
00edb218 A |
514 | @param FileName A pointer to the name of the file to\r |
515 | find within the firmware volume.\r | |
00edb218 | 516 | @param VolumeHandle The firmware volume to search FileHandle\r |
959ccb23 | 517 | Upon exit, points to the found file's\r |
518 | handle or NULL if it could not be found.\r | |
519 | \r | |
00edb218 | 520 | @retval EFI_SUCCESS File was found.\r |
00edb218 | 521 | @retval EFI_NOT_FOUND File was not found.\r |
00edb218 A |
522 | @retval EFI_INVALID_PARAMETER VolumeHandle or FileHandle or\r |
523 | FileName was NULL.\r | |
959ccb23 | 524 | \r |
959ccb23 | 525 | **/\r |
526 | typedef\r | |
527 | EFI_STATUS\r | |
6de794cd | 528 | (EFIAPI *EFI_PEI_FFS_FIND_BY_NAME)(\r |
00edb218 A |
529 | IN CONST EFI_GUID *FileName,\r |
530 | IN CONST EFI_PEI_FV_HANDLE VolumeHandle,\r | |
531 | OUT EFI_PEI_FILE_HANDLE *FileHandle\r | |
532 | );\r | |
959ccb23 | 533 | \r |
534 | \r | |
535 | /**\r | |
536 | \r | |
00edb218 | 537 | @param FileName Name of the file.\r |
00edb218 | 538 | @param FileType File type. See EFI_FV_FILETYPE, which is\r |
959ccb23 | 539 | defined in the Platform Initialization\r |
540 | Firmware Storage Specification.\r | |
00edb218 | 541 | @param FileAttributes Attributes of the file. Type\r |
959ccb23 | 542 | EFI_FV_FILE_ATTRIBUTES is defined in\r |
543 | the Platform Initialization Firmware\r | |
544 | Storage Specification.\r | |
00edb218 | 545 | @param Buffer Points to the file's data (not the header).\r |
959ccb23 | 546 | Not valid if EFI_FV_FILE_ATTRIB_MEMORY_MAPPED\r |
547 | is zero.\r | |
00edb218 | 548 | @param BufferSize Size of the file's data.\r |
959ccb23 | 549 | \r |
550 | **/\r | |
551 | typedef struct {\r | |
00edb218 A |
552 | EFI_GUID FileName;\r |
553 | EFI_FV_FILETYPE FileType;\r | |
554 | EFI_FV_FILE_ATTRIBUTES FileAttributes;\r | |
555 | VOID *Buffer;\r | |
556 | UINT32 BufferSize;\r | |
959ccb23 | 557 | } EFI_FV_FILE_INFO;\r |
558 | \r | |
559 | /**\r | |
00edb218 A |
560 | This function returns information about a specific file,\r |
561 | including its file name, type, attributes, starting address and\r | |
562 | size. If the firmware volume is not memory mapped then the\r | |
959ccb23 | 563 | Buffer member will be NULL.\r |
564 | \r | |
565 | @param FileHandle Handle of the file.\r | |
5528573c | 566 | @param FileInfo Upon exit, points to the file's\r |
959ccb23 | 567 | information.\r |
568 | \r | |
00edb218 | 569 | @retval EFI_SUCCESS File information returned.\r |
00edb218 | 570 | @retval EFI_INVALID_PARAMETER If FileHandle does not\r |
959ccb23 | 571 | represent a valid file.\r |
00edb218 | 572 | @retval EFI_INVALID_PARAMETER If FileInfo is NULL.\r |
959ccb23 | 573 | \r |
574 | **/\r | |
575 | typedef\r | |
576 | EFI_STATUS\r | |
6de794cd | 577 | (EFIAPI *EFI_PEI_FFS_GET_FILE_INFO)(\r |
00edb218 | 578 | IN CONST EFI_PEI_FILE_HANDLE FileHandle,\r |
1c280088 | 579 | OUT EFI_FV_FILE_INFO *FileInfo\r |
00edb218 | 580 | );\r |
959ccb23 | 581 | \r |
582 | \r | |
583 | /**\r | |
584 | \r | |
00edb218 | 585 | @param FvAttributes Attributes of the firmware volume. Type\r |
4ba967e7 | 586 | EFI_FVB_ATTRIBUTES_2 is defined in the\r |
959ccb23 | 587 | Platform Initialization Firmware Storage\r |
588 | Specficiation.\r | |
589 | \r | |
00edb218 | 590 | @param FvFormat Format of the firmware volume. For PI\r |
959ccb23 | 591 | Architecture Firmware Volumes, this can\r |
592 | be copied from FileSystemGuid in\r | |
593 | EFI_FIRMWARE_VOLUME_HEADER.\r | |
594 | \r | |
00edb218 | 595 | @param FvName Name of the firmware volume. For PI\r |
959ccb23 | 596 | Architecture Firmware Volumes, this can\r |
597 | be copied from VolumeName in the\r | |
598 | extended header of\r | |
599 | EFI_FIRMWARE_VOLUME_HEADER.\r | |
600 | \r | |
00edb218 | 601 | @param FvStart Points to the first byte of the firmware\r |
959ccb23 | 602 | volume, if bit EFI_FVB_MEMORY_MAPPED is\r |
603 | set in FvAttributes. FvSize Size of the\r | |
604 | firmware volume.\r | |
605 | \r | |
606 | **/\r | |
607 | typedef struct {\r | |
4ba967e7 | 608 | EFI_FVB_ATTRIBUTES_2 FvAttributes;\r |
609 | EFI_GUID FvFormat;\r | |
610 | EFI_GUID FvName;\r | |
611 | VOID *FvStart;\r | |
612 | UINT64 FvSize;\r | |
959ccb23 | 613 | } EFI_FV_INFO;\r |
614 | \r | |
615 | /**\r | |
616 | \r | |
00edb218 A |
617 | This function returns information about a specific firmware\r |
618 | volume, including its name, type, attributes, starting address\r | |
959ccb23 | 619 | and size.\r |
620 | \r | |
621 | @param VolumeHandle Handle of the volume.\r | |
622 | \r | |
5528573c | 623 | @param VolumeInfo Upon exit, points to the volume's\r |
959ccb23 | 624 | information.\r |
625 | \r | |
00edb218 | 626 | @retval EFI_SUCCESS File information returned.\r |
00edb218 | 627 | @retval EFI_INVALID_PARAMETER If FileHandle does not\r |
959ccb23 | 628 | represent a valid file.\r |
00edb218 | 629 | @retval EFI_INVALID_PARAMETER If FileInfo is NULL.\r |
959ccb23 | 630 | \r |
631 | **/\r | |
632 | typedef\r | |
633 | EFI_STATUS\r | |
6de794cd | 634 | (EFIAPI *EFI_PEI_FFS_GET_VOLUME_INFO)(\r |
1c280088 | 635 | IN EFI_PEI_FV_HANDLE VolumeHandle,\r |
636 | OUT EFI_FV_INFO *VolumeInfo\r | |
00edb218 | 637 | );\r |
959ccb23 | 638 | \r |
639 | /**\r | |
640 | \r | |
00edb218 A |
641 | This service registers a file handle so that after memory is\r |
642 | available, the PEIM will be re-loaded into permanent memory and\r | |
643 | re-initialized. The PEIM registered this way will always be\r | |
644 | initialized twice. The first time, this function call will\r | |
645 | return EFI_SUCCESS. The second time, this function call will\r | |
646 | return EFI_ALREADY_STARTED. Depending on the order in which\r | |
647 | PEIMs are dispatched, the PEIM making this call may be\r | |
648 | initialized after permanent memory is installed, even the first\r | |
959ccb23 | 649 | time.\r |
650 | \r | |
5528573c | 651 | @param FileHandle PEIM's file handle. Must be the currently\r |
67c89a21 | 652 | executing PEIM.\r |
959ccb23 | 653 | \r |
4ba967e7 | 654 | @retval EFI_SUCCESS The PEIM was successfully registered for\r |
655 | shadowing.\r | |
00edb218 | 656 | @retval EFI_ALREADY_STARTED The PEIM was previously\r |
959ccb23 | 657 | registered for shadowing.\r |
4ba967e7 | 658 | @retval EFI_NOT_FOUND The FileHandle does not refer to a\r |
659 | valid file handle.\r | |
959ccb23 | 660 | \r |
661 | **/\r | |
662 | typedef\r | |
663 | EFI_STATUS\r | |
6de794cd | 664 | (EFIAPI *EFI_PEI_REGISTER_FOR_SHADOW)(\r |
1c280088 | 665 | IN EFI_PEI_FILE_HANDLE FileHandle\r |
00edb218 | 666 | );\r |
959ccb23 | 667 | \r |
668 | \r | |
669 | //\r | |
670 | // PEI Specification Revision information\r | |
671 | //\r | |
672 | #define PEI_SPECIFICATION_MAJOR_REVISION 1\r | |
673 | #define PEI_SPECIFICATION_MINOR_REVISION 0\r | |
674 | \r | |
675 | //\r | |
676 | // PEI Services Table\r | |
677 | //\r | |
f490a61d | 678 | #define PEI_SERVICES_SIGNATURE 0x5652455320494550ULL\r |
ef4fa1a4 | 679 | #define PEI_SERVICES_REVISION ((PEI_SPECIFICATION_MAJOR_REVISION<<16) | (PEI_SPECIFICATION_MINOR_REVISION))\r |
959ccb23 | 680 | \r |
6de794cd | 681 | /// \r |
682 | /// EFI_PEI_SERVICES is a collection of functions whose implementation is provided by the PEI\r | |
683 | /// Foundation. These services fall into various classes, including the following:\r | |
684 | /// - Managing the boot mode\r | |
685 | /// - Allocating both early and permanent memory\r | |
686 | /// - Supporting the Firmware File System (FFS)\r | |
687 | /// - Abstracting the PPI database abstraction\r | |
688 | /// - Creating Hand-Off Blocks (HOBs)\r | |
689 | ///\r | |
146332ae | 690 | struct _EFI_PEI_SERVICES {\r |
00edb218 A |
691 | EFI_TABLE_HEADER Hdr;\r |
692 | //\r | |
693 | // PPI Functions\r | |
694 | //\r | |
695 | EFI_PEI_INSTALL_PPI InstallPpi;\r | |
696 | EFI_PEI_REINSTALL_PPI ReInstallPpi;\r | |
697 | EFI_PEI_LOCATE_PPI LocatePpi;\r | |
698 | EFI_PEI_NOTIFY_PPI NotifyPpi;\r | |
699 | //\r | |
700 | // Boot Mode Functions\r | |
701 | //\r | |
702 | EFI_PEI_GET_BOOT_MODE GetBootMode;\r | |
703 | EFI_PEI_SET_BOOT_MODE SetBootMode;\r | |
704 | //\r | |
705 | // HOB Functions\r | |
706 | //\r | |
707 | EFI_PEI_GET_HOB_LIST GetHobList;\r | |
708 | EFI_PEI_CREATE_HOB CreateHob;\r | |
709 | //\r | |
710 | // Firmware Volume Functions\r | |
711 | //\r | |
712 | EFI_PEI_FFS_FIND_NEXT_VOLUME2 FfsFindNextVolume;\r | |
713 | EFI_PEI_FFS_FIND_NEXT_FILE2 FfsFindNextFile;\r | |
714 | EFI_PEI_FFS_FIND_SECTION_DATA2 FfsFindSectionData;\r | |
715 | //\r | |
716 | // PEI Memory Functions\r | |
717 | //\r | |
718 | EFI_PEI_INSTALL_PEI_MEMORY InstallPeiMemory;\r | |
719 | EFI_PEI_ALLOCATE_PAGES AllocatePages;\r | |
720 | EFI_PEI_ALLOCATE_POOL AllocatePool;\r | |
721 | EFI_PEI_COPY_MEM CopyMem;\r | |
722 | EFI_PEI_SET_MEM SetMem;\r | |
723 | //\r | |
724 | // Status Code\r | |
725 | EFI_PEI_REPORT_STATUS_CODE ReportStatusCode;\r | |
726 | //\r | |
727 | // Reset\r | |
728 | //\r | |
729 | EFI_PEI_RESET_SYSTEM ResetSystem;\r | |
730 | //\r | |
731 | // (the following interfaces are installed by publishing PEIM)\r | |
732 | //\r | |
733 | // I/O Abstractions\r | |
734 | //\r | |
735 | EFI_PEI_CPU_IO_PPI *CpuIo;\r | |
736 | EFI_PEI_PCI_CFG2_PPI *PciCfg;\r | |
737 | //\r | |
738 | // Future Installed Services\r | |
739 | EFI_PEI_FFS_FIND_BY_NAME FfsFindFileByName;\r | |
740 | EFI_PEI_FFS_GET_FILE_INFO FfsGetFileInfo;\r | |
741 | EFI_PEI_FFS_GET_VOLUME_INFO FfsGetVolumeInfo;\r | |
742 | EFI_PEI_REGISTER_FOR_SHADOW RegisterForShadow;\r | |
743 | };\r | |
959ccb23 | 744 | \r |
745 | \r | |
6de794cd | 746 | ///\r |
747 | /// EFI_SEC_PEI_HAND_OFF structure hold information about\r | |
748 | /// PEI core's operating environment, such as the size of location of\r | |
749 | /// temporary RAM, the stack location and BFV location.\r | |
750 | /// \r | |
959ccb23 | 751 | typedef struct _EFI_SEC_PEI_HAND_OFF {\r |
752 | //\r | |
753 | // Size of the data structure.\r | |
754 | // \r | |
755 | UINT16 DataSize;\r | |
756 | \r | |
757 | //\r | |
758 | // Points to the first byte of the boot firmware volume, \r | |
759 | // which the PEI Dispatcher should search for \r | |
760 | // PEI modules.\r | |
761 | // \r | |
762 | VOID *BootFirmwareVolumeBase;\r | |
763 | \r | |
764 | //\r | |
765 | // Size of the boot firmware volume, in bytes.\r | |
766 | // \r | |
767 | UINTN BootFirmwareVolumeSize;\r | |
768 | \r | |
769 | //\r | |
770 | // Points to the first byte of the temporary RAM.\r | |
771 | // \r | |
772 | VOID *TemporaryRamBase;\r | |
773 | \r | |
774 | //\r | |
775 | // Size of the temporary RAM, in bytes.\r | |
776 | // \r | |
777 | UINTN TemporaryRamSize;\r | |
778 | \r | |
779 | //\r | |
780 | // Points to the first byte of the temporary RAM \r | |
781 | // available for use by the PEI Foundation. The area \r | |
782 | // described by PeiTemporaryRamBase and PeiTemporaryRamSize \r | |
783 | // must not extend outside beyond the area described by\r | |
784 | // TemporaryRamBase & TemporaryRamSize. This area should not\r | |
785 | // overlap with the area reported by StackBase and \r | |
786 | // StackSize.\r | |
787 | //\r | |
788 | VOID *PeiTemporaryRamBase;\r | |
789 | \r | |
790 | //\r | |
791 | // Size of the available temporary RAM available for \r | |
792 | // use by the PEI Foundation, in bytes.\r | |
793 | // \r | |
794 | UINTN PeiTemporaryRamSize;\r | |
795 | \r | |
796 | //\r | |
797 | // Points to the first byte of the stack. \r | |
798 | // This are may be part of the memory described by \r | |
799 | // TemporaryRamBase and TemporaryRamSize \r | |
800 | // or may be an entirely separate area.\r | |
801 | // \r | |
802 | VOID *StackBase;\r | |
803 | \r | |
804 | //\r | |
805 | // Size of the stack, in bytes.\r | |
806 | // \r | |
807 | UINTN StackSize;\r | |
808 | } EFI_SEC_PEI_HAND_OFF;\r | |
809 | \r | |
fb3df220 | 810 | \r |
811 | /**\r | |
812 | \r | |
813 | This function is the entry point for the PEI Foundation, which\r | |
814 | allows the SEC phase to pass information about the stack,\r | |
815 | temporary RAM and the Boot Firmware Volume. In addition, it also\r | |
816 | allows the SEC phase to pass services and data forward for use\r | |
817 | during the PEI phase in the form of one or more PPIs. There is\r | |
818 | no limit to the number of additional PPIs that can be passed\r | |
819 | from SEC into the PEI Foundation. As part of its initialization\r | |
820 | phase, the PEI Foundation will add these SEC-hosted PPIs to its\r | |
821 | PPI database such that both the PEI Foundation and any modules\r | |
822 | can leverage the associated service calls and/or code in these\r | |
823 | early PPIs.\r | |
824 | \r | |
825 | @param SecCoreData Points to a data structure containing\r | |
826 | information about the PEI core's\r | |
827 | operating environment, such as the size\r | |
828 | and location of temporary RAM, the stack\r | |
829 | location and the BFV location. The type\r | |
830 | EFI_SEC_PEI_HAND_OFF is\r | |
831 | \r | |
832 | @param PpiList Points to a list of one or more PPI\r | |
833 | descriptors to be installed initially by\r | |
834 | the PEI core. An empty PPI list consists\r | |
835 | of a single descriptor with the end-tag\r | |
836 | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST.\r | |
837 | As part of its initialization phase, the\r | |
838 | PEI Foundation will add these SEC-hosted\r | |
839 | PPIs to its PPI database such that both\r | |
840 | the PEI Foundation and any modules can\r | |
841 | leverage the associated service calls\r | |
842 | and/or code in these early PPIs.\r | |
843 | \r | |
844 | \r | |
845 | **/\r | |
846 | typedef\r | |
847 | VOID\r | |
e5544398 | 848 | (EFIAPI *EFI_PEI_CORE_ENTRY_POINT)(\r |
fb3df220 | 849 | IN CONST EFI_SEC_PEI_HAND_OFF *SecCoreData,\r |
850 | IN CONST EFI_PEI_PPI_DESCRIPTOR *PpiList\r | |
851 | );\r | |
852 | \r | |
959ccb23 | 853 | #endif\r |