2 PI PEI master include file. This file should match the PI spec.
4 Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials are licensed and made available under
6 the terms and conditions of the BSD License that accompanies this distribution.
7 The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php.
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
14 @par Revision Reference:
19 #ifndef __PI_PEICIS_H__
20 #define __PI_PEICIS_H__
22 #include <Uefi/UefiMultiPhase.h>
23 #include <Pi/PiMultiPhase.h>
26 /// The handles of EFI FV.
28 typedef VOID
*EFI_PEI_FV_HANDLE
;
31 /// The handles of EFI FFS.
33 typedef VOID
*EFI_PEI_FILE_HANDLE
;
36 /// Declare the forward reference data structure for EFI_PEI_SERVICE.
38 typedef struct _EFI_PEI_SERVICES EFI_PEI_SERVICES
;
41 /// Declare the forward reference data structure for EFI_PEI_NOTIFY_DESCRIPTOR.
43 typedef struct _EFI_PEI_NOTIFY_DESCRIPTOR EFI_PEI_NOTIFY_DESCRIPTOR
;
46 #include <Ppi/CpuIo.h>
47 #include <Ppi/PciCfg2.h>
51 The PEI Dispatcher will invoke each PEIM one time. During this pass, the PEI
52 Dispatcher will pass control to the PEIM at the AddressOfEntryPoint in the PE Header.
54 @param FileHandle Pointer to the FFS file header.
55 @param PeiServices Describes the list of possible PEI Services.
57 @retval EFI_SUCCESS The PEI completed successfully.
58 @retval !EFI_SUCCESS There is error in PEIM.
63 (EFIAPI
*EFI_PEIM_ENTRY_POINT2
)(
64 IN EFI_PEI_FILE_HANDLE FileHandle
,
65 IN CONST EFI_PEI_SERVICES
**PeiServices
69 Entry point of the notification callback function itself within the PEIM.
71 @param PeiServices Indirect reference to the PEI Services Table.
72 @param NotifyDescriptor Address of the notification descriptor data structure.
73 @param Ppi Address of the PPI that was installed.
75 @return Status of the notification.
76 The status code returned from this function is ignored.
80 (EFIAPI
*EFI_PEIM_NOTIFY_ENTRY_POINT
)(
81 IN EFI_PEI_SERVICES
**PeiServices
,
82 IN EFI_PEI_NOTIFY_DESCRIPTOR
*NotifyDescriptor
,
87 // PEI Ppi Services List Descriptors
89 #define EFI_PEI_PPI_DESCRIPTOR_PIC 0x00000001
90 #define EFI_PEI_PPI_DESCRIPTOR_PPI 0x00000010
91 #define EFI_PEI_PPI_DESCRIPTOR_NOTIFY_CALLBACK 0x00000020
92 #define EFI_PEI_PPI_DESCRIPTOR_NOTIFY_DISPATCH 0x00000040
93 #define EFI_PEI_PPI_DESCRIPTOR_NOTIFY_TYPES 0x00000060
94 #define EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST 0x80000000
97 /// The data structure through which a PEIM describes available services to the PEI Foundation.
101 /// This field is a set of flags describing the characteristics of this imported table entry.
102 /// All flags are defined as EFI_PEI_PPI_DESCRIPTOR_***, which can also be combined into one.
106 /// The address of the EFI_GUID that names the interface.
110 /// A pointer to the PPI. It contains the information necessary to install a service.
113 } EFI_PEI_PPI_DESCRIPTOR
;
116 /// The data structure in a given PEIM that tells the PEI
117 /// Foundation where to invoke the notification service.
119 struct _EFI_PEI_NOTIFY_DESCRIPTOR
{
121 /// Details if the type of notification are callback or dispatch.
125 /// The address of the EFI_GUID that names the interface.
129 /// Address of the notification callback function itself within the PEIM.
131 EFI_PEIM_NOTIFY_ENTRY_POINT Notify
;
135 /// This data structure is the means by which callable services are installed and
136 /// notifications are registered in the PEI phase.
140 /// The typedef structure of the notification descriptor.
142 EFI_PEI_NOTIFY_DESCRIPTOR Notify
;
144 /// The typedef structure of the PPI descriptor.
146 EFI_PEI_PPI_DESCRIPTOR Ppi
;
147 } EFI_PEI_DESCRIPTOR
;
150 This service is the first one provided by the PEI Foundation. This function
151 installs an interface in the PEI PPI database by GUID. The purpose of the
152 service is to publish an interface that other parties can use to call
155 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table
156 published by the PEI Foundation.
157 @param PpiList A pointer to the list of interfaces that the caller shall install.
159 @retval EFI_SUCCESS The interface was successfully installed.
160 @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL or Any of the PEI PPI
161 descriptors in the list do not have the
162 EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field.
163 @retval EFI_OUT_OF_RESOURCES There is no additional space in the PPI database.
168 (EFIAPI
*EFI_PEI_INSTALL_PPI
)(
169 IN CONST EFI_PEI_SERVICES
**PeiServices
,
170 IN CONST EFI_PEI_PPI_DESCRIPTOR
*PpiList
174 This function reinstalls an interface in the PEI PPI database by GUID.
175 The purpose of the service is to publish an interface that other parties
176 can use to replace a same-named interface in the protocol database
177 with a different interface.
179 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table
180 published by the PEI Foundation.
181 @param OldPpi A pointer to the former PPI in the database.
182 @param NewPpi A pointer to the new interfaces that the caller shall install.
184 @retval EFI_SUCCESS The interface was successfully installed.
185 @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL or Any of the PEI PPI descriptors in the
186 list do not have the EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field.
187 @retval EFI_OUT_OF_RESOURCES There is no additional space in the PPI database.
188 @retval EFI_NOT_FOUND The PPI for which the reinstallation was requested has not been installed.
193 (EFIAPI
*EFI_PEI_REINSTALL_PPI
)(
194 IN CONST EFI_PEI_SERVICES
**PeiServices
,
195 IN CONST EFI_PEI_PPI_DESCRIPTOR
*OldPpi
,
196 IN CONST EFI_PEI_PPI_DESCRIPTOR
*NewPpi
200 This function locates an interface in the PEI PPI database by GUID.
202 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES published by the PEI Foundation.
203 @param Guid A pointer to the GUID whose corresponding interface needs to be found.
204 @param Instance The N-th instance of the interface that is required.
205 @param PpiDescriptor A pointer to instance of the EFI_PEI_PPI_DESCRIPTOR.
206 @param Ppi A pointer to the instance of the interface.
208 @retval EFI_SUCCESS The interface was successfully returned.
209 @retval EFI_NOT_FOUND The PPI descriptor is not found in the database.
214 (EFIAPI
*EFI_PEI_LOCATE_PPI
)(
215 IN CONST EFI_PEI_SERVICES
**PeiServices
,
216 IN CONST EFI_GUID
*Guid
,
218 IN OUT EFI_PEI_PPI_DESCRIPTOR
**PpiDescriptor OPTIONAL
,
223 This function installs a notification service to be called back when a
224 given interface is installed or reinstalled. The purpose of the service
225 is to publish an interface that other parties can use to call additional PPIs
226 that may materialize later.
228 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation
229 @param NotifyList A pointer to the list of notification interfaces that the caller shall install.
231 @retval EFI_SUCCESS The interface was successfully installed.
232 @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL, or any of the PEI PPI descriptors in the
233 list do not have the EFI_PEI_PPI_DESCRIPTOR_NOTIFY_TYPES bit set in the Flags field.
234 @retval EFI_OUT_OF_RESOURCES There is no additional space in the PPI database.
239 (EFIAPI
*EFI_PEI_NOTIFY_PPI
)(
240 IN CONST EFI_PEI_SERVICES
**PeiServices
,
241 IN CONST EFI_PEI_NOTIFY_DESCRIPTOR
*NotifyList
245 This function returns the present value of the boot mode.
247 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
248 @param BootMode A pointer to contain the value of the boot mode.
250 @retval EFI_SUCCESS The boot mode returned successfully.
255 (EFIAPI
*EFI_PEI_GET_BOOT_MODE
)(
256 IN CONST EFI_PEI_SERVICES
**PeiServices
,
257 OUT EFI_BOOT_MODE
*BootMode
261 This function sets the value of the boot mode.
263 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation
264 @param BootMode The value of the boot mode to set.
266 @retval EFI_SUCCESS The boot mode returned successfully.
271 (EFIAPI
*EFI_PEI_SET_BOOT_MODE
)(
272 IN CONST EFI_PEI_SERVICES
**PeiServices
,
273 IN EFI_BOOT_MODE BootMode
277 This function returns the pointer to the list of Hand-Off Blocks (HOBs) in memory.
279 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation
280 @param HobList A pointer to the list of HOBs that the PEI Foundation will initialize
282 @retval EFI_SUCCESS The list was successfully returned.
283 @retval EFI_NOT_AVAILABLE_YET The HOB list is not yet published.
288 (EFIAPI
*EFI_PEI_GET_HOB_LIST
)(
289 IN CONST EFI_PEI_SERVICES
**PeiServices
,
294 This service, published by the PEI Foundation, abstracts the creation of a Hand-Off Block's (HOB's) headers.
296 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
297 @param Type The type of HOB to be installed.
298 @param Length The length of the HOB to be added.
299 @param Hob The address of a pointer that will contain the HOB header.
301 @retval EFI_SUCCESS The HOB was successfully created.
302 @retval EFI_OUT_OF_RESOURCES There is no additional space for HOB creation.
307 (EFIAPI
*EFI_PEI_CREATE_HOB
)(
308 IN CONST EFI_PEI_SERVICES
**PeiServices
,
315 The purpose of the service is to abstract the capability of the PEI
316 Foundation to discover instances of firmware volumes in the system.
318 This service enables PEIMs to discover additional firmware volumes. The PEI Foundation uses this
319 service to abstract the locations and formats of various firmware volumes. These volumes include
320 the Boot Firmware Volume and any other volumes exposed by EFI_PEI_FV_PPI. The service
321 returns a volume handle of type EFI_PEI_FV_HANDLE, which must be unique within the system.
323 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
324 @param Instance This instance of the firmware volume to find.
325 The value 0 is the Boot Firmware Volume (BFV).
326 @param VolumeHandle On exit, points to the next volumn handle or NULL if it does not exist.
328 @retval EFI_SUCCESS The volume was found.
329 @retval EFI_NOT_FOUND The volume was not found.
330 @retval EFI_INVALID_PARAMETER VolumeHandle is NULL.
335 (EFIAPI
*EFI_PEI_FFS_FIND_NEXT_VOLUME2
)(
336 IN CONST EFI_PEI_SERVICES
**PeiServices
,
338 OUT EFI_PEI_FV_HANDLE
*VolumeHandle
342 Searches for the next matching file in the firmware volume.
344 This service enables PEIMs to discover firmware files within a specified volume.
345 To find the first instance of a firmware file, pass a FileHandle value of NULL into the service.
346 The service returns a file handle of type EFI_PEI_FILE_HANDLE, which must be unique within
349 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
350 @param SearchType A filter to find files only of this type.
351 @param FvHandle Handle of firmware volume in which to search.
352 @param FileHandle On entry, points to the current handle from which to begin searching
353 or NULL to start at the beginning of the firmware volume.
354 On exit, points the file handle of the next file in the volume or NULL
355 if there are no more files.
357 @retval EFI_SUCCESS The file was found.
358 @retval EFI_NOT_FOUND The file was not found.
359 @retval EFI_NOT_FOUND The header checksum was not zero.
364 (EFIAPI
*EFI_PEI_FFS_FIND_NEXT_FILE2
)(
365 IN CONST EFI_PEI_SERVICES
**PeiServices
,
366 IN EFI_FV_FILETYPE SearchType
,
367 IN CONST EFI_PEI_FV_HANDLE FvHandle
,
368 IN OUT EFI_PEI_FILE_HANDLE
*FileHandle
372 Searches for the next matching section within the specified file.
374 This service enables PEI modules to discover the first section of a given type within a valid file.
375 This service will search within encapsulation sections (compression and GUIDed) as well. It will
376 search inside of a GUIDed section or a compressed section, but may not, for example, search a
377 GUIDed section inside a GUIDes section.
378 This service will not search within compression sections or GUIDed sections that require
379 extraction if memory is not present.
381 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
382 @param SectionType The value of the section type to find.
383 @param FileHandle Handle of the firmware file to search.
384 @param SectionData A pointer to the discovered section, if successful.
386 @retval EFI_SUCCESS The section was found.
387 @retval EFI_NOT_FOUND The section was not found.
392 (EFIAPI
*EFI_PEI_FFS_FIND_SECTION_DATA2
)(
393 IN CONST EFI_PEI_SERVICES
**PeiServices
,
394 IN EFI_SECTION_TYPE SectionType
,
395 IN EFI_PEI_FILE_HANDLE FileHandle
,
396 OUT VOID
**SectionData
400 Searches for the next matching section within the specified file.
402 This service enables PEI modules to discover the section of a given type within a valid file.
403 This service will search within encapsulation sections (compression and GUIDed) as well. It will
404 search inside of a GUIDed section or a compressed section, but may not, for example, search a
405 GUIDed section inside a GUIDes section.
406 This service will not search within compression sections or GUIDed sections that require
407 extraction if memory is not present.
409 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
410 @param SectionType The value of the section type to find.
411 @param SectionInstance Section instance to find.
412 @param FileHandle Handle of the firmware file to search.
413 @param SectionData A pointer to the discovered section, if successful.
414 @param AuthenticationStatus A pointer to the authentication status for this section.
416 @retval EFI_SUCCESS The section was found.
417 @retval EFI_NOT_FOUND The section was not found.
422 (EFIAPI
*EFI_PEI_FFS_FIND_SECTION_DATA3
)(
423 IN CONST EFI_PEI_SERVICES
**PeiServices
,
424 IN EFI_SECTION_TYPE SectionType
,
425 IN UINTN SectionInstance
,
426 IN EFI_PEI_FILE_HANDLE FileHandle
,
427 OUT VOID
**SectionData
,
428 OUT UINT32
*AuthenticationStatus
432 This function registers the found memory configuration with the PEI Foundation.
434 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
435 @param MemoryBegin The value of a region of installed memory.
436 @param MemoryLength The corresponding length of a region of installed memory.
438 @retval EFI_SUCCESS The region was successfully installed in a HOB.
439 @retval EFI_INVALID_PARAMETER MemoryBegin and MemoryLength are illegal for this system.
440 @retval EFI_OUT_OF_RESOURCES There is no additional space for HOB creation.
445 (EFIAPI
*EFI_PEI_INSTALL_PEI_MEMORY
)(
446 IN CONST EFI_PEI_SERVICES
**PeiServices
,
447 IN EFI_PHYSICAL_ADDRESS MemoryBegin
,
448 IN UINT64 MemoryLength
452 The purpose of the service is to publish an interface that allows
453 PEIMs to allocate memory ranges that are managed by the PEI Foundation.
455 Prior to InstallPeiMemory() being called, PEI will allocate pages from the heap.
456 After InstallPeiMemory() is called, PEI will allocate pages within the region
457 of memory provided by InstallPeiMemory() service in a best-effort fashion.
458 Location-specific allocations are not managed by the PEI foundation code.
460 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
461 @param MemoryType The type of memory to allocate.
462 @param Pages The number of contiguous 4 KB pages to allocate.
463 @param Memory A pointer to a physical address. On output, the address is set to the base
464 of the page range that was allocated.
466 @retval EFI_SUCCESS The memory range was successfully allocated.
467 @retval EFI_OUT_OF_RESOURCES The pages could not be allocated.
468 @retval EFI_INVALID_PARAMETER The type is not equal to EfiLoaderCode, EfiLoaderData, EfiRuntimeServicesCode,
469 EfiRuntimeServicesData, EfiBootServicesCode, EfiBootServicesData,
470 EfiACPIReclaimMemory, EfiReservedMemoryType, or EfiACPIMemoryNVS.
475 (EFIAPI
*EFI_PEI_ALLOCATE_PAGES
)(
476 IN CONST EFI_PEI_SERVICES
**PeiServices
,
477 IN EFI_MEMORY_TYPE MemoryType
,
479 OUT EFI_PHYSICAL_ADDRESS
*Memory
485 @param[in] PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
486 @param[in] Memory The base physical address of the pages to be freed.
487 @param[in] Pages The number of contiguous 4 KB pages to free.
489 @retval EFI_SUCCESS The requested pages were freed.
490 @retval EFI_INVALID_PARAMETER Memory is not a page-aligned address or Pages is invalid.
491 @retval EFI_NOT_FOUND The requested memory pages were not allocated with
497 (EFIAPI
*EFI_PEI_FREE_PAGES
) (
498 IN CONST EFI_PEI_SERVICES
**PeiServices
,
499 IN EFI_PHYSICAL_ADDRESS Memory
,
504 The purpose of this service is to publish an interface that
505 allows PEIMs to allocate memory ranges that are managed by the PEI Foundation.
507 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
508 @param Size The number of bytes to allocate from the pool.
509 @param Buffer If the call succeeds, a pointer to a pointer to the allocated buffer; undefined otherwise.
511 @retval EFI_SUCCESS The allocation was successful.
512 @retval EFI_OUT_OF_RESOURCES There is not enough heap to allocate the requested size.
517 (EFIAPI
*EFI_PEI_ALLOCATE_POOL
)(
518 IN CONST EFI_PEI_SERVICES
**PeiServices
,
524 This service copies the contents of one buffer to another buffer.
526 @param Destination The pointer to the destination buffer of the memory copy.
527 @param Source The pointer to the source buffer of the memory copy.
528 @param Length The number of bytes to copy from Source to Destination.
533 (EFIAPI
*EFI_PEI_COPY_MEM
)(
534 IN VOID
*Destination
,
540 The service fills a buffer with a specified value.
542 @param Buffer The pointer to the buffer to fill.
543 @param Size The number of bytes in Buffer to fill.
544 @param Value The value to fill Buffer with.
549 (EFIAPI
*EFI_PEI_SET_MEM
)(
556 This service publishes an interface that allows PEIMs to report status codes.
558 ReportStatusCode() is called by PEIMs that wish to report status information on their
559 progress. The principal use model is for a PEIM to emit one of the standard 32-bit error codes. This
560 will allow a platform owner to ascertain the state of the system, especially under conditions where
561 the full consoles might not have been installed.
563 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
564 @param Type Indicates the type of status code being reported.
565 @param Value Describes the current status of a hardware or
566 software entity. This includes information about the class and
567 subclass that is used to classify the entity as well as an operation.
568 For progress codes, the operation is the current activity.
569 For error codes, it is the exception.For debug codes,it is not defined at this time.
570 @param Instance The enumeration of a hardware or software entity within
571 the system. A system may contain multiple entities that match a class/subclass
572 pairing. The instance differentiates between them. An instance of 0 indicates
573 that instance information is unavailable, not meaningful, or not relevant.
574 Valid instance numbers start with 1.
575 @param CallerId This optional parameter may be used to identify the caller.
576 This parameter allows the status code driver to apply different rules to
578 @param Data This optional parameter may be used to pass additional data.
580 @retval EFI_SUCCESS The function completed successfully.
581 @retval EFI_NOT_AVAILABLE_YET No progress code provider has installed an interface in the system.
586 (EFIAPI
*EFI_PEI_REPORT_STATUS_CODE
)(
587 IN CONST EFI_PEI_SERVICES
**PeiServices
,
588 IN EFI_STATUS_CODE_TYPE Type
,
589 IN EFI_STATUS_CODE_VALUE Value
,
591 IN CONST EFI_GUID
*CallerId OPTIONAL
,
592 IN CONST EFI_STATUS_CODE_DATA
*Data OPTIONAL
596 Resets the entire platform.
598 This service resets the entire platform, including all processors
599 and devices, and reboots the system.
600 This service will never return EFI_SUCCESS.
602 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES
603 table published by the PEI Foundation.
605 @retval EFI_NOT_AVAILABLE_YET The service has not been installed yet.
610 (EFIAPI
*EFI_PEI_RESET_SYSTEM
)(
611 IN CONST EFI_PEI_SERVICES
**PeiServices
615 Resets the entire platform.
617 @param[in] ResetType The type of reset to perform.
618 @param[in] ResetStatus The status code for the reset.
619 @param[in] DataSize The size, in bytes, of ResetData.
620 @param[in] ResetData For a ResetType of EfiResetCold, EfiResetWarm, or EfiResetShutdown
621 the data buffer starts with a Null-terminated string, optionally
622 followed by additional binary data. The string is a description
623 that the caller may use to further indicate the reason for the
624 system reset. ResetData is only valid if ResetStatus is something
625 other than EFI_SUCCESS unless the ResetType is EfiResetPlatformSpecific
626 where a minimum amount of ResetData is always required.
631 (EFIAPI
*EFI_PEI_RESET2_SYSTEM
) (
632 IN EFI_RESET_TYPE ResetType
,
633 IN EFI_STATUS ResetStatus
,
635 IN VOID
*ResetData OPTIONAL
639 Find a file within a volume by its name.
641 This service searches for files with a specific name, within
642 either the specified firmware volume or all firmware volumes.
643 The service returns a file handle of type EFI_PEI_FILE_HANDLE,
644 which must be unique within the system.
646 @param FileName A pointer to the name of the file to
647 find within the firmware volume.
648 @param VolumeHandle The firmware volume to search.
649 @param FileHandle Upon exit, points to the found file's
650 handle or NULL if it could not be found.
652 @retval EFI_SUCCESS The file was found.
653 @retval EFI_NOT_FOUND The file was not found.
654 @retval EFI_INVALID_PARAMETER VolumeHandle or FileHandle or
660 (EFIAPI
*EFI_PEI_FFS_FIND_BY_NAME
)(
661 IN CONST EFI_GUID
*FileName
,
662 IN EFI_PEI_FV_HANDLE VolumeHandle
,
663 OUT EFI_PEI_FILE_HANDLE
*FileHandle
667 /// The information of the FV file.
671 /// Name of the file.
677 EFI_FV_FILETYPE FileType
;
679 /// Attributes of the file.
681 EFI_FV_FILE_ATTRIBUTES FileAttributes
;
683 /// Points to the file's data (not the header).
684 /// Not valid if EFI_FV_FILE_ATTRIB_MEMORY_MAPPED
689 /// Size of the file's data.
695 /// The information with authentication status of the FV file.
699 /// Name of the file.
705 EFI_FV_FILETYPE FileType
;
707 /// Attributes of the file.
709 EFI_FV_FILE_ATTRIBUTES FileAttributes
;
711 /// Points to the file's data (not the header).
712 /// Not valid if EFI_FV_FILE_ATTRIB_MEMORY_MAPPED
717 /// Size of the file's data.
721 /// Authentication status for this file.
723 UINT32 AuthenticationStatus
;
727 Returns information about a specific file.
729 This function returns information about a specific file,
730 including its file name, type, attributes, starting address and
731 size. If the firmware volume is not memory mapped, then the
732 Buffer member will be NULL.
734 @param FileHandle The handle of the file.
735 @param FileInfo Upon exit, points to the file's
738 @retval EFI_SUCCESS File information was returned.
739 @retval EFI_INVALID_PARAMETER FileHandle does not
740 represent a valid file.
741 @retval EFI_INVALID_PARAMETER FileInfo is NULL.
746 (EFIAPI
*EFI_PEI_FFS_GET_FILE_INFO
)(
747 IN EFI_PEI_FILE_HANDLE FileHandle
,
748 OUT EFI_FV_FILE_INFO
*FileInfo
752 Returns information about a specific file.
754 This function returns information about a specific file,
755 including its file name, type, attributes, starting address, size and authentication status.
756 If the firmware volume is not memory mapped, then the Buffer member will be NULL.
758 @param FileHandle The handle of the file.
759 @param FileInfo Upon exit, points to the file's
762 @retval EFI_SUCCESS File information was returned.
763 @retval EFI_INVALID_PARAMETER FileHandle does not
764 represent a valid file.
765 @retval EFI_INVALID_PARAMETER FileInfo is NULL.
770 (EFIAPI
*EFI_PEI_FFS_GET_FILE_INFO2
)(
771 IN EFI_PEI_FILE_HANDLE FileHandle
,
772 OUT EFI_FV_FILE_INFO2
*FileInfo
776 /// The information of the FV volume.
780 /// Attributes of the firmware volume.
782 EFI_FVB_ATTRIBUTES_2 FvAttributes
;
784 /// Format of the firmware volume.
788 /// Name of the firmware volume.
792 /// Points to the first byte of the firmware
793 /// volume, if bit EFI_FVB_MEMORY_MAPPED is
794 /// set in FvAttributes.
798 /// Size of the firmware volume.
804 Returns information about the specified volume.
806 This function returns information about a specific firmware
807 volume, including its name, type, attributes, starting address
810 @param VolumeHandle Handle of the volume.
811 @param VolumeInfo Upon exit, points to the volume's information.
813 @retval EFI_SUCCESS The volume information returned.
814 @retval EFI_INVALID_PARAMETER If VolumeHandle does not represent a valid volume.
815 @retval EFI_INVALID_PARAMETER If VolumeHandle is NULL.
816 @retval EFI_SUCCESS Information was successfully returned.
817 @retval EFI_INVALID_PARAMETER The volume designated by the VolumeHandle is not available.
822 (EFIAPI
*EFI_PEI_FFS_GET_VOLUME_INFO
)(
823 IN EFI_PEI_FV_HANDLE VolumeHandle
,
824 OUT EFI_FV_INFO
*VolumeInfo
828 Register a PEIM so that it will be shadowed and called again.
830 This service registers a file handle so that after memory is
831 available, the PEIM will be re-loaded into permanent memory and
832 re-initialized. The PEIM registered this way will always be
833 initialized twice. The first time, this function call will
834 return EFI_SUCCESS. The second time, this function call will
835 return EFI_ALREADY_STARTED. Depending on the order in which
836 PEIMs are dispatched, the PEIM making this call may be
837 initialized after permanent memory is installed, even the first
840 @param FileHandle PEIM's file handle. Must be the currently
843 @retval EFI_SUCCESS The PEIM was successfully registered for
845 @retval EFI_ALREADY_STARTED The PEIM was previously
846 registered for shadowing.
847 @retval EFI_NOT_FOUND The FileHandle does not refer to a
853 (EFIAPI
*EFI_PEI_REGISTER_FOR_SHADOW
)(
854 IN EFI_PEI_FILE_HANDLE FileHandle
859 // PEI Specification Revision information
861 #define PEI_SPECIFICATION_MAJOR_REVISION 1
862 #define PEI_SPECIFICATION_MINOR_REVISION 40
864 /// Specification inconsistency here:
865 /// In the PI1.0 spec, PEI_SERVICES_SIGNATURE is defined as 0x5652455320494550. But
866 /// to pass a multiple tool chain, it appends an ULL.
869 // PEI Services Table
871 #define PEI_SERVICES_SIGNATURE 0x5652455320494550ULL
873 /// Specification inconsistency here:
874 /// In the PI1.0 specification, there is a typo error in PEI_SERVICES_REVISION. In the specification the defintion is
875 /// #define ((PEI_SPECIFICATION_MAJOR_REVISION<<16) |(PEI_SPECIFICATION_MINOR_REVISION))
876 /// and it should be as follows:
878 #define PEI_SERVICES_REVISION ((PEI_SPECIFICATION_MAJOR_REVISION<<16) | (PEI_SPECIFICATION_MINOR_REVISION))
881 /// EFI_PEI_SERVICES is a collection of functions whose implementation is provided by the PEI
882 /// Foundation. These services fall into various classes, including the following:
883 /// - Managing the boot mode
884 /// - Allocating both early and permanent memory
885 /// - Supporting the Firmware File System (FFS)
886 /// - Abstracting the PPI database abstraction
887 /// - Creating Hand-Off Blocks (HOBs).
889 struct _EFI_PEI_SERVICES
{
891 /// The table header for the PEI Services Table.
893 EFI_TABLE_HEADER Hdr
;
898 EFI_PEI_INSTALL_PPI InstallPpi
;
899 EFI_PEI_REINSTALL_PPI ReInstallPpi
;
900 EFI_PEI_LOCATE_PPI LocatePpi
;
901 EFI_PEI_NOTIFY_PPI NotifyPpi
;
904 // Boot Mode Functions
906 EFI_PEI_GET_BOOT_MODE GetBootMode
;
907 EFI_PEI_SET_BOOT_MODE SetBootMode
;
912 EFI_PEI_GET_HOB_LIST GetHobList
;
913 EFI_PEI_CREATE_HOB CreateHob
;
916 // Firmware Volume Functions
918 EFI_PEI_FFS_FIND_NEXT_VOLUME2 FfsFindNextVolume
;
919 EFI_PEI_FFS_FIND_NEXT_FILE2 FfsFindNextFile
;
920 EFI_PEI_FFS_FIND_SECTION_DATA2 FfsFindSectionData
;
923 // PEI Memory Functions
925 EFI_PEI_INSTALL_PEI_MEMORY InstallPeiMemory
;
926 EFI_PEI_ALLOCATE_PAGES AllocatePages
;
927 EFI_PEI_ALLOCATE_POOL AllocatePool
;
928 EFI_PEI_COPY_MEM CopyMem
;
929 EFI_PEI_SET_MEM SetMem
;
934 EFI_PEI_REPORT_STATUS_CODE ReportStatusCode
;
939 EFI_PEI_RESET_SYSTEM ResetSystem
;
942 // (the following interfaces are installed by publishing PEIM)
945 EFI_PEI_CPU_IO_PPI
*CpuIo
;
946 EFI_PEI_PCI_CFG2_PPI
*PciCfg
;
949 // Future Installed Services
951 EFI_PEI_FFS_FIND_BY_NAME FfsFindFileByName
;
952 EFI_PEI_FFS_GET_FILE_INFO FfsGetFileInfo
;
953 EFI_PEI_FFS_GET_VOLUME_INFO FfsGetVolumeInfo
;
954 EFI_PEI_REGISTER_FOR_SHADOW RegisterForShadow
;
955 EFI_PEI_FFS_FIND_SECTION_DATA3 FindSectionData3
;
956 EFI_PEI_FFS_GET_FILE_INFO2 FfsGetFileInfo2
;
957 EFI_PEI_RESET2_SYSTEM ResetSystem2
;
958 EFI_PEI_FREE_PAGES FreePages
;
963 /// EFI_SEC_PEI_HAND_OFF structure holds information about
964 /// PEI core's operating environment, such as the size of location of
965 /// temporary RAM, the stack location and BFV location.
967 typedef struct _EFI_SEC_PEI_HAND_OFF
{
969 /// Size of the data structure.
974 /// Points to the first byte of the boot firmware volume,
975 /// which the PEI Dispatcher should search for
978 VOID
*BootFirmwareVolumeBase
;
981 /// Size of the boot firmware volume, in bytes.
983 UINTN BootFirmwareVolumeSize
;
986 /// Points to the first byte of the temporary RAM.
988 VOID
*TemporaryRamBase
;
991 /// Size of the temporary RAM, in bytes.
993 UINTN TemporaryRamSize
;
996 /// Points to the first byte of the temporary RAM
997 /// available for use by the PEI Foundation. The area
998 /// described by PeiTemporaryRamBase and PeiTemporaryRamSize
999 /// must not extend outside beyond the area described by
1000 /// TemporaryRamBase & TemporaryRamSize. This area should not
1001 /// overlap with the area reported by StackBase and
1004 VOID
*PeiTemporaryRamBase
;
1007 /// The size of the available temporary RAM available for
1008 /// use by the PEI Foundation, in bytes.
1010 UINTN PeiTemporaryRamSize
;
1013 /// Points to the first byte of the stack.
1014 /// This are may be part of the memory described by
1015 /// TemporaryRamBase and TemporaryRamSize
1016 /// or may be an entirely separate area.
1021 /// Size of the stack, in bytes.
1024 } EFI_SEC_PEI_HAND_OFF
;
1028 The entry point of PEI Foundation.
1030 This function is the entry point for the PEI Foundation, which
1031 allows the SEC phase to pass information about the stack,
1032 temporary RAM and the Boot Firmware Volume. In addition, it also
1033 allows the SEC phase to pass services and data forward for use
1034 during the PEI phase in the form of one or more PPIs. These PPI's
1035 will be installed and/or immediately signaled if they are
1036 notification type. There is no limit to the number of additional
1037 PPIs that can be passed from SEC into the PEI Foundation. As part
1038 of its initialization phase, the PEI Foundation will add these
1039 SEC-hosted PPIs to its PPI database such that both the PEI
1040 Foundation and any modules can leverage the associated service
1041 calls and/or code in these early PPIs.
1043 @param SecCoreData Points to a data structure containing
1044 information about the PEI core's
1045 operating environment, such as the size
1046 and location of temporary RAM, the stack
1047 location and the BFV location.
1049 @param PpiList Points to a list of one or more PPI
1050 descriptors to be installed initially by
1051 the PEI core. An empty PPI list consists
1052 of a single descriptor with the end-tag
1053 EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST.
1054 As part of its initialization phase, the
1055 PEI Foundation will add these SEC-hosted
1056 PPIs to its PPI database such that both
1057 the PEI Foundation and any modules can
1058 leverage the associated service calls
1059 and/or code in these early PPIs.
1065 (EFIAPI
*EFI_PEI_CORE_ENTRY_POINT
)(
1066 IN CONST EFI_SEC_PEI_HAND_OFF
*SecCoreData
,
1067 IN CONST EFI_PEI_PPI_DESCRIPTOR
*PpiList