/** @file\r
PI PEI master include file. This file should match the PI spec.\r
\r
-Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials are licensed and made available under \r
-the terms and conditions of the BSD License that accompanies this distribution. \r
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under\r
+the terms and conditions of the BSD License that accompanies this distribution.\r
The full text of the license may be found at\r
-http://opensource.org/licenses/bsd-license.php. \r
- \r
+http://opensource.org/licenses/bsd-license.php.\r
\r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
+\r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
@par Revision Reference:\r
- PI Version 1.2.\r
+ PI Version 1.6.\r
\r
**/\r
\r
\r
///\r
/// The handles of EFI FV.\r
-/// \r
+///\r
typedef VOID *EFI_PEI_FV_HANDLE;\r
\r
///\r
/// The handles of EFI FFS.\r
-/// \r
+///\r
typedef VOID *EFI_PEI_FILE_HANDLE;\r
\r
///\r
/// Declare the forward reference data structure for EFI_PEI_SERVICE.\r
-/// \r
+///\r
typedef struct _EFI_PEI_SERVICES EFI_PEI_SERVICES;\r
\r
///\r
/// Declare the forward reference data structure for EFI_PEI_NOTIFY_DESCRIPTOR.\r
-/// \r
+///\r
typedef struct _EFI_PEI_NOTIFY_DESCRIPTOR EFI_PEI_NOTIFY_DESCRIPTOR;\r
\r
\r
\r
\r
/**\r
- The PEI Dispatcher will invoke each PEIM one time. During this pass, the PEI \r
- Dispatcher will pass control to the PEIM at the AddressOfEntryPoint in the PE Header. \r
+ The PEI Dispatcher will invoke each PEIM one time. During this pass, the PEI\r
+ Dispatcher will pass control to the PEIM at the AddressOfEntryPoint in the PE Header.\r
\r
@param FileHandle Pointer to the FFS file header.\r
@param PeiServices Describes the list of possible PEI Services.\r
@param Ppi Address of the PPI that was installed.\r
\r
@return Status of the notification.\r
+ The status code returned from this function is ignored.\r
**/\r
typedef\r
EFI_STATUS\r
\r
///\r
/// The data structure through which a PEIM describes available services to the PEI Foundation.\r
-/// \r
+///\r
typedef struct {\r
///\r
/// This field is a set of flags describing the characteristics of this imported table entry.\r
VOID *Ppi;\r
} EFI_PEI_PPI_DESCRIPTOR;\r
\r
-/// \r
-/// The data structure in a given PEIM that tells the PEI \r
+///\r
+/// The data structure in a given PEIM that tells the PEI\r
/// Foundation where to invoke the notification service.\r
-/// \r
+///\r
struct _EFI_PEI_NOTIFY_DESCRIPTOR {\r
///\r
/// Details if the type of notification are callback or dispatch.\r
} EFI_PEI_DESCRIPTOR;\r
\r
/**\r
- This service is the first one provided by the PEI Foundation. This function \r
- installs an interface in the PEI PPI database by GUID. The purpose of the \r
- service is to publish an interface that other parties can use to call \r
+ This service is the first one provided by the PEI Foundation. This function\r
+ installs an interface in the PEI PPI database by GUID. The purpose of the\r
+ service is to publish an interface that other parties can use to call\r
additional PEIMs.\r
\r
@param PeiServices An indirect pointer to the EFI_PEI_SERVICES table\r
@param PpiList A pointer to the list of interfaces that the caller shall install.\r
\r
@retval EFI_SUCCESS The interface was successfully installed.\r
- @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL or Any of the PEI PPI \r
- descriptors in the list do not have the \r
+ @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL or Any of the PEI PPI\r
+ descriptors in the list do not have the\r
EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field.\r
@retval EFI_OUT_OF_RESOURCES There is no additional space in the PPI database.\r
\r
);\r
\r
/**\r
- This function reinstalls an interface in the PEI PPI database by GUID. \r
- The purpose of the service is to publish an interface that other parties \r
- can use to replace a same-named interface in the protocol database \r
- with a different interface. \r
+ This function reinstalls an interface in the PEI PPI database by GUID.\r
+ The purpose of the service is to publish an interface that other parties\r
+ can use to replace a same-named interface in the protocol database\r
+ with a different interface.\r
\r
@param PeiServices An indirect pointer to the EFI_PEI_SERVICES table\r
published by the PEI Foundation.\r
@param NewPpi A pointer to the new interfaces that the caller shall install.\r
\r
@retval EFI_SUCCESS The interface was successfully installed.\r
- @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL or Any of the PEI PPI descriptors in the \r
+ @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL or Any of the PEI PPI descriptors in the\r
list do not have the EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field.\r
@retval EFI_OUT_OF_RESOURCES There is no additional space in the PPI database.\r
@retval EFI_NOT_FOUND The PPI for which the reinstallation was requested has not been installed.\r
);\r
\r
/**\r
- This function locates an interface in the PEI PPI database by GUID. \r
+ This function locates an interface in the PEI PPI database by GUID.\r
\r
@param PeiServices An indirect pointer to the EFI_PEI_SERVICES published by the PEI Foundation.\r
@param Guid A pointer to the GUID whose corresponding interface needs to be found.\r
);\r
\r
/**\r
- This function installs a notification service to be called back when a \r
- given interface is installed or reinstalled. The purpose of the service \r
- is to publish an interface that other parties can use to call additional PPIs \r
+ This function installs a notification service to be called back when a\r
+ given interface is installed or reinstalled. The purpose of the service\r
+ is to publish an interface that other parties can use to call additional PPIs\r
that may materialize later.\r
\r
@param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation\r
@param NotifyList A pointer to the list of notification interfaces that the caller shall install.\r
\r
@retval EFI_SUCCESS The interface was successfully installed.\r
- @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL, or any of the PEI PPI descriptors in the \r
- list do not have the EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field.\r
+ @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL, or any of the PEI PPI descriptors in the\r
+ list do not have the EFI_PEI_PPI_DESCRIPTOR_NOTIFY_TYPES bit set in the Flags field.\r
@retval EFI_OUT_OF_RESOURCES There is no additional space in the PPI database.\r
\r
**/\r
);\r
\r
/**\r
- This function returns the pointer to the list of Hand-Off Blocks (HOBs) in memory. \r
+ This function returns the pointer to the list of Hand-Off Blocks (HOBs) in memory.\r
\r
@param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation\r
@param HobList A pointer to the list of HOBs that the PEI Foundation will initialize\r
);\r
\r
/**\r
- The purpose of the service is to abstract the capability of the PEI \r
- Foundation to discover instances of firmware volumes in the system. \r
+ The purpose of the service is to abstract the capability of the PEI\r
+ Foundation to discover instances of firmware volumes in the system.\r
\r
This service enables PEIMs to discover additional firmware volumes. The PEI Foundation uses this\r
service to abstract the locations and formats of various firmware volumes. These volumes include\r
OUT VOID **SectionData\r
);\r
\r
+/**\r
+ Searches for the next matching section within the specified file.\r
+\r
+ This service enables PEI modules to discover the section of a given type within a valid file.\r
+ This service will search within encapsulation sections (compression and GUIDed) as well. It will\r
+ search inside of a GUIDed section or a compressed section, but may not, for example, search a\r
+ GUIDed section inside a GUIDes section.\r
+ This service will not search within compression sections or GUIDed sections that require\r
+ extraction if memory is not present.\r
+\r
+ @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
+ @param SectionType The value of the section type to find.\r
+ @param SectionInstance Section instance to find.\r
+ @param FileHandle Handle of the firmware file to search.\r
+ @param SectionData A pointer to the discovered section, if successful.\r
+ @param AuthenticationStatus A pointer to the authentication status for this section.\r
+\r
+ @retval EFI_SUCCESS The section was found.\r
+ @retval EFI_NOT_FOUND The section was not found.\r
+\r
+**/\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *EFI_PEI_FFS_FIND_SECTION_DATA3)(\r
+ IN CONST EFI_PEI_SERVICES **PeiServices,\r
+ IN EFI_SECTION_TYPE SectionType,\r
+ IN UINTN SectionInstance,\r
+ IN EFI_PEI_FILE_HANDLE FileHandle,\r
+ OUT VOID **SectionData,\r
+ OUT UINT32 *AuthenticationStatus\r
+ );\r
+\r
/**\r
This function registers the found memory configuration with the PEI Foundation.\r
\r
);\r
\r
/**\r
- The purpose of the service is to publish an interface that allows \r
+ The purpose of the service is to publish an interface that allows\r
PEIMs to allocate memory ranges that are managed by the PEI Foundation.\r
\r
+ Prior to InstallPeiMemory() being called, PEI will allocate pages from the heap.\r
+ After InstallPeiMemory() is called, PEI will allocate pages within the region\r
+ of memory provided by InstallPeiMemory() service in a best-effort fashion.\r
+ Location-specific allocations are not managed by the PEI foundation code.\r
+\r
@param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
@param MemoryType The type of memory to allocate.\r
@param Pages The number of contiguous 4 KB pages to allocate.\r
- @param Memory A pointer to a physical address. On output, the address is set to the base \r
+ @param Memory A pointer to a physical address. On output, the address is set to the base\r
of the page range that was allocated.\r
\r
@retval EFI_SUCCESS The memory range was successfully allocated.\r
@retval EFI_OUT_OF_RESOURCES The pages could not be allocated.\r
- @retval EFI_INVALID_PARAMETER The type is not equal to EfiLoaderCode, EfiLoaderData, EfiRuntimeServicesCode, \r
+ @retval EFI_INVALID_PARAMETER The type is not equal to EfiLoaderCode, EfiLoaderData, EfiRuntimeServicesCode,\r
EfiRuntimeServicesData, EfiBootServicesCode, EfiBootServicesData,\r
- EfiACPIReclaimMemory, or EfiACPIMemoryNVS.\r
+ EfiACPIReclaimMemory, EfiReservedMemoryType, or EfiACPIMemoryNVS.\r
\r
**/\r
typedef\r
);\r
\r
/**\r
- The purpose of this service is to publish an interface that \r
+ Frees memory pages.\r
+\r
+ @param[in] PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
+ @param[in] Memory The base physical address of the pages to be freed.\r
+ @param[in] Pages The number of contiguous 4 KB pages to free.\r
+\r
+ @retval EFI_SUCCESS The requested pages were freed.\r
+ @retval EFI_INVALID_PARAMETER Memory is not a page-aligned address or Pages is invalid.\r
+ @retval EFI_NOT_FOUND The requested memory pages were not allocated with\r
+ AllocatePages().\r
+\r
+**/\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *EFI_PEI_FREE_PAGES) (\r
+ IN CONST EFI_PEI_SERVICES **PeiServices,\r
+ IN EFI_PHYSICAL_ADDRESS Memory,\r
+ IN UINTN Pages\r
+ );\r
+\r
+/**\r
+ The purpose of this service is to publish an interface that\r
allows PEIMs to allocate memory ranges that are managed by the PEI Foundation.\r
\r
@param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
\r
This service resets the entire platform, including all processors\r
and devices, and reboots the system.\r
- This service will never return EFI_SUCCESS. \r
+ This service will never return EFI_SUCCESS.\r
\r
@param PeiServices An indirect pointer to the EFI_PEI_SERVICES\r
table published by the PEI Foundation.\r
IN CONST EFI_PEI_SERVICES **PeiServices\r
);\r
\r
+/**\r
+ Resets the entire platform.\r
+\r
+ @param[in] ResetType The type of reset to perform.\r
+ @param[in] ResetStatus The status code for the reset.\r
+ @param[in] DataSize The size, in bytes, of ResetData.\r
+ @param[in] ResetData For a ResetType of EfiResetCold, EfiResetWarm, or EfiResetShutdown\r
+ the data buffer starts with a Null-terminated string, optionally\r
+ followed by additional binary data. The string is a description\r
+ that the caller may use to further indicate the reason for the\r
+ system reset. ResetData is only valid if ResetStatus is something\r
+ other than EFI_SUCCESS unless the ResetType is EfiResetPlatformSpecific\r
+ where a minimum amount of ResetData is always required.\r
+\r
+**/\r
+typedef\r
+VOID\r
+(EFIAPI *EFI_PEI_RESET2_SYSTEM) (\r
+ IN EFI_RESET_TYPE ResetType,\r
+ IN EFI_STATUS ResetStatus,\r
+ IN UINTN DataSize,\r
+ IN VOID *ResetData OPTIONAL\r
+ );\r
+\r
/**\r
Find a file within a volume by its name.\r
\r
UINT32 BufferSize;\r
} EFI_FV_FILE_INFO;\r
\r
+///\r
+/// The information with authentication status of the FV file.\r
+///\r
+typedef struct {\r
+ ///\r
+ /// Name of the file.\r
+ ///\r
+ EFI_GUID FileName;\r
+ ///\r
+ /// File type.\r
+ ///\r
+ EFI_FV_FILETYPE FileType;\r
+ ///\r
+ /// Attributes of the file.\r
+ ///\r
+ EFI_FV_FILE_ATTRIBUTES FileAttributes;\r
+ ///\r
+ /// Points to the file's data (not the header).\r
+ /// Not valid if EFI_FV_FILE_ATTRIB_MEMORY_MAPPED\r
+ /// is zero.\r
+ ///\r
+ VOID *Buffer;\r
+ ///\r
+ /// Size of the file's data.\r
+ ///\r
+ UINT32 BufferSize;\r
+ ///\r
+ /// Authentication status for this file.\r
+ ///\r
+ UINT32 AuthenticationStatus;\r
+} EFI_FV_FILE_INFO2;\r
+\r
/**\r
Returns information about a specific file.\r
\r
@retval EFI_INVALID_PARAMETER FileHandle does not\r
represent a valid file.\r
@retval EFI_INVALID_PARAMETER FileInfo is NULL.\r
- \r
+\r
**/\r
typedef\r
EFI_STATUS\r
OUT EFI_FV_FILE_INFO *FileInfo\r
);\r
\r
+/**\r
+ Returns information about a specific file.\r
+\r
+ This function returns information about a specific file,\r
+ including its file name, type, attributes, starting address, size and authentication status.\r
+ If the firmware volume is not memory mapped, then the Buffer member will be NULL.\r
+\r
+ @param FileHandle The handle of the file.\r
+ @param FileInfo Upon exit, points to the file's\r
+ information.\r
+\r
+ @retval EFI_SUCCESS File information was returned.\r
+ @retval EFI_INVALID_PARAMETER FileHandle does not\r
+ represent a valid file.\r
+ @retval EFI_INVALID_PARAMETER FileInfo is NULL.\r
+\r
+**/\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *EFI_PEI_FFS_GET_FILE_INFO2)(\r
+ IN EFI_PEI_FILE_HANDLE FileHandle,\r
+ OUT EFI_FV_FILE_INFO2 *FileInfo\r
+ );\r
+\r
///\r
/// The information of the FV volume.\r
///\r
\r
@param FileHandle PEIM's file handle. Must be the currently\r
executing PEIM.\r
- \r
+\r
@retval EFI_SUCCESS The PEIM was successfully registered for\r
shadowing.\r
@retval EFI_ALREADY_STARTED The PEIM was previously\r
// PEI Specification Revision information\r
//\r
#define PEI_SPECIFICATION_MAJOR_REVISION 1\r
-#define PEI_SPECIFICATION_MINOR_REVISION 20\r
+#define PEI_SPECIFICATION_MINOR_REVISION 60\r
///\r
-/// Specification inconsistency here: \r
-/// In the PI1.0 spec, PEI_SERVICES_SIGNATURE is defined as 0x5652455320494550. But \r
+/// Specification inconsistency here:\r
+/// In the PI1.0 spec, PEI_SERVICES_SIGNATURE is defined as 0x5652455320494550. But\r
/// to pass a multiple tool chain, it appends an ULL.\r
///\r
//\r
//\r
#define PEI_SERVICES_SIGNATURE 0x5652455320494550ULL\r
///\r
-/// Specification inconsistency here: \r
-/// In the PI1.0 specification, there is a typo error in PEI_SERVICES_REVISION. In the specification the defintion is \r
+/// Specification inconsistency here:\r
+/// In the PI1.0 specification, there is a typo error in PEI_SERVICES_REVISION. In the specification the defintion is\r
/// #define ((PEI_SPECIFICATION_MAJOR_REVISION<<16) |(PEI_SPECIFICATION_MINOR_REVISION))\r
/// and it should be as follows:\r
///\r
#define PEI_SERVICES_REVISION ((PEI_SPECIFICATION_MAJOR_REVISION<<16) | (PEI_SPECIFICATION_MINOR_REVISION))\r
\r
-/// \r
+///\r
/// EFI_PEI_SERVICES is a collection of functions whose implementation is provided by the PEI\r
/// Foundation. These services fall into various classes, including the following:\r
/// - Managing the boot mode\r
EFI_PEI_FFS_GET_FILE_INFO FfsGetFileInfo;\r
EFI_PEI_FFS_GET_VOLUME_INFO FfsGetVolumeInfo;\r
EFI_PEI_REGISTER_FOR_SHADOW RegisterForShadow;\r
+ EFI_PEI_FFS_FIND_SECTION_DATA3 FindSectionData3;\r
+ EFI_PEI_FFS_GET_FILE_INFO2 FfsGetFileInfo2;\r
+ EFI_PEI_RESET2_SYSTEM ResetSystem2;\r
+ EFI_PEI_FREE_PAGES FreePages;\r
};\r
\r
\r
/// EFI_SEC_PEI_HAND_OFF structure holds information about\r
/// PEI core's operating environment, such as the size of location of\r
/// temporary RAM, the stack location and BFV location.\r
-/// \r
+///\r
typedef struct _EFI_SEC_PEI_HAND_OFF {\r
///\r
/// Size of the data structure.\r
- /// \r
+ ///\r
UINT16 DataSize;\r
\r
///\r
- /// Points to the first byte of the boot firmware volume, \r
- /// which the PEI Dispatcher should search for \r
+ /// Points to the first byte of the boot firmware volume,\r
+ /// which the PEI Dispatcher should search for\r
/// PEI modules.\r
- /// \r
+ ///\r
VOID *BootFirmwareVolumeBase;\r
\r
///\r
/// Size of the boot firmware volume, in bytes.\r
- /// \r
+ ///\r
UINTN BootFirmwareVolumeSize;\r
\r
///\r
/// Points to the first byte of the temporary RAM.\r
- /// \r
+ ///\r
VOID *TemporaryRamBase;\r
\r
///\r
/// Size of the temporary RAM, in bytes.\r
- /// \r
+ ///\r
UINTN TemporaryRamSize;\r
\r
///\r
- /// Points to the first byte of the temporary RAM \r
- /// available for use by the PEI Foundation. The area \r
- /// described by PeiTemporaryRamBase and PeiTemporaryRamSize \r
+ /// Points to the first byte of the temporary RAM\r
+ /// available for use by the PEI Foundation. The area\r
+ /// described by PeiTemporaryRamBase and PeiTemporaryRamSize\r
/// must not extend outside beyond the area described by\r
/// TemporaryRamBase & TemporaryRamSize. This area should not\r
- /// overlap with the area reported by StackBase and \r
+ /// overlap with the area reported by StackBase and\r
/// StackSize.\r
///\r
VOID *PeiTemporaryRamBase;\r
\r
///\r
- /// The size of the available temporary RAM available for \r
+ /// The size of the available temporary RAM available for\r
/// use by the PEI Foundation, in bytes.\r
- /// \r
+ ///\r
UINTN PeiTemporaryRamSize;\r
\r
///\r
- /// Points to the first byte of the stack. \r
- /// This are may be part of the memory described by \r
- /// TemporaryRamBase and TemporaryRamSize \r
+ /// Points to the first byte of the stack.\r
+ /// This are may be part of the memory described by\r
+ /// TemporaryRamBase and TemporaryRamSize\r
/// or may be an entirely separate area.\r
- /// \r
+ ///\r
VOID *StackBase;\r
\r
///\r
/// Size of the stack, in bytes.\r
- /// \r
+ ///\r
UINTN StackSize;\r
} EFI_SEC_PEI_HAND_OFF;\r
\r
allows the SEC phase to pass information about the stack,\r
temporary RAM and the Boot Firmware Volume. In addition, it also\r
allows the SEC phase to pass services and data forward for use\r
- during the PEI phase in the form of one or more PPIs. There is\r
- no limit to the number of additional PPIs that can be passed\r
- from SEC into the PEI Foundation. As part of its initialization\r
- phase, the PEI Foundation will add these SEC-hosted PPIs to its\r
- PPI database such that both the PEI Foundation and any modules\r
- can leverage the associated service calls and/or code in these\r
- early PPIs.\r
+ during the PEI phase in the form of one or more PPIs. These PPI's\r
+ will be installed and/or immediately signaled if they are\r
+ notification type. There is no limit to the number of additional\r
+ PPIs that can be passed from SEC into the PEI Foundation. As part\r
+ of its initialization phase, the PEI Foundation will add these\r
+ SEC-hosted PPIs to its PPI database such that both the PEI\r
+ Foundation and any modules can leverage the associated service\r
+ calls and/or code in these early PPIs.\r
\r
@param SecCoreData Points to a data structure containing\r
information about the PEI core's\r
projects / mirror_edk2.git / blobdiff