/** @file\r
Definition of Pei Core Structures and Services\r
\r
-Copyright (c) 2006 - 2007, Intel Corporation\r
+Copyright (c) 2006 - 2008, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
#include <Guid/FirmwareFileSystem2.h>\r
#include <Guid/AprioriFileName.h>\r
\r
+///\r
+/// It is an FFS type extension used for PeiFindFileEx. It indicates current\r
+/// Ffs searching is for all PEIMs can be dispatched by PeiCore.\r
+///\r
#define PEI_CORE_INTERNAL_FFS_FILE_DISPATCH_TYPE 0xff\r
\r
///\r
UINTN CurrentPeimFvCount;\r
UINTN CurrentPeimCount;\r
EFI_PEI_FILE_HANDLE CurrentFileHandle;\r
+ BOOLEAN PeimNeedingDispatch;\r
+ BOOLEAN PeimDispatchOnThisPass;\r
+ BOOLEAN PeimDispatcherReenter;\r
UINTN AllFvCount;\r
EFI_PEI_FV_HANDLE AllFv[FixedPcdGet32 (PcdPeiCoreMaxFvSupported)];\r
EFI_PEI_HOB_POINTERS HobList;\r
BOOLEAN PeiMemoryInstalled;\r
EFI_PHYSICAL_ADDRESS StackBase;\r
UINT64 StackSize;\r
- VOID *BottomOfCarHeap;\r
- VOID *TopOfCarHeap;\r
VOID *CpuIo;\r
EFI_PEI_SECURITY2_PPI *PrivateSecurityPpi;\r
EFI_PEI_SERVICES ServiceTableShadow;\r
- UINTN SizeOfTemporaryMemory;\r
- UINTN SizeOfCacheAsRam;\r
- VOID *MaxTopOfCarHeap;\r
EFI_PEI_PPI_DESCRIPTOR *XipLoadFile;\r
EFI_PHYSICAL_ADDRESS PhysicalMemoryBegin;\r
UINT64 PhysicalMemoryLength;\r
#define PEI_CORE_INSTANCE_FROM_PS_THIS(a) \\r
CR(a, PEI_CORE_INSTANCE, PS, PEI_CORE_HANDLE_SIGNATURE)\r
\r
+/**\r
+ Function Pointer type for PeiCore function.\r
+ @param SecCoreData Points to a data structure containing information about the PEI core's operating\r
+ environment, such as the size and location of temporary RAM, the stack location and\r
+ the BFV location.\r
+ @param PpiList Points to a list of one or more PPI descriptors to be installed initially by the PEI core.\r
+ An empty PPI list consists of a single descriptor with the end-tag\r
+ EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST. As part of its initialization\r
+ phase, the PEI Foundation will add these SEC-hosted PPIs to its PPI database such\r
+ that both the PEI Foundation and any modules can leverage the associated service\r
+ calls and/or code in these early PPIs\r
+ @param Data Pointer to old core data that is used to initialize the\r
+ core's data areas.\r
+**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *PEI_CORE_ENTRY_POINT)(\r
+(EFIAPI *PEICORE_FUNCTION_POINTER)(\r
IN CONST EFI_SEC_PEI_HAND_OFF *SecCoreData,\r
IN CONST EFI_PEI_PPI_DESCRIPTOR *PpiList,\r
IN PEI_CORE_INSTANCE *OldCoreData\r
/// Union of temporarily used function pointers (to save stack space)\r
///\r
typedef union {\r
- PEI_CORE_ENTRY_POINT PeiCore;\r
+ PEICORE_FUNCTION_POINTER PeiCore;\r
EFI_PEIM_ENTRY_POINT2 PeimEntry;\r
EFI_PEIM_NOTIFY_ENTRY_POINT PeimNotifyEntry;\r
EFI_DXE_IPL_PPI *DxeIpl;\r
VOID *Raw;\r
} PEI_CORE_TEMP_POINTERS;\r
\r
-\r
-\r
typedef struct {\r
CONST EFI_SEC_PEI_HAND_OFF *SecCoreData;\r
EFI_PEI_PPI_DESCRIPTOR *PpiList;\r
@retval EFI_NOT_FOUND Never reach\r
\r
**/\r
-EFI_STATUS\r
+VOID\r
EFIAPI\r
PeiCore (\r
IN CONST EFI_SEC_PEI_HAND_OFF *SecCoreData,\r
- IN CONST EFI_PEI_PPI_DESCRIPTOR *PpList,\r
+ IN CONST EFI_PEI_PPI_DESCRIPTOR *PpiList,\r
IN VOID *Data\r
- )\r
-;\r
+ );\r
\r
//\r
// Dispatcher support functions\r
PeimDispatchReadiness (\r
IN EFI_PEI_SERVICES **PeiServices,\r
IN VOID *DependencyExpression\r
- )\r
-;\r
+ );\r
\r
/**\r
Conduct PEIM dispatch.\r
\r
- @param SecCoreData Points to a data structure containing information about the PEI core's operating\r
- environment, such as the size and location of temporary RAM, the stack location and\r
- the BFV location.\r
+ @param SecCoreData Pointer to the data structure containing SEC to PEI handoff data\r
@param PrivateData Pointer to the private data passed in from caller\r
\r
- @retval EFI_SUCCESS Successfully dispatched PEIM.\r
- @retval EFI_NOT_FOUND The dispatch failed.\r
-\r
**/\r
VOID\r
PeiDispatcher (\r
IN CONST EFI_SEC_PEI_HAND_OFF *SecCoreData,\r
IN PEI_CORE_INSTANCE *PrivateData\r
- )\r
-;\r
+ );\r
\r
/**\r
Initialize the Dispatcher's data members\r
IN PEI_CORE_INSTANCE *PrivateData,\r
IN PEI_CORE_INSTANCE *OldCoreData,\r
IN CONST EFI_SEC_PEI_HAND_OFF *SecCoreData\r
- )\r
-;\r
+ );\r
\r
/**\r
This routine parses the Dependency Expression, if available, and\r
\r
@param Private PeiCore's private data structure\r
@param FileHandle PEIM's file handle\r
- @param PeimCount Peim count in all dispatched PEIMs.\r
+ @param PeimCount The index of last dispatched PEIM.\r
\r
- @retval TRUE Can be dispatched\r
- @retval FALSE Cannot be dispatched\r
+ @retval TRUE Can be dispatched\r
+ @retval FALSE Cannot be dispatched\r
\r
**/\r
BOOLEAN\r
IN PEI_CORE_INSTANCE *Private,\r
IN EFI_PEI_FILE_HANDLE FileHandle,\r
IN UINTN PeimCount\r
- )\r
-;\r
+ );\r
\r
//\r
// PPI support functions\r
InitializePpiServices (\r
IN PEI_CORE_INSTANCE *PrivateData,\r
IN PEI_CORE_INSTANCE *OldCoreData\r
- )\r
-;\r
+ );\r
\r
/**\r
\r
Migrate the Hob list from the CAR stack to PEI installed memory.\r
\r
- @param PeiServices The PEI core services table.\r
- @param OldCheckingBottom The old checking bottom.\r
- @param OldCheckingTop The old checking top.\r
+ @param PrivateData Pointer to PeiCore's private data structure.\r
+ @param OldCheckingBottom Bottom of temporary memory range. All Ppi in this range\r
+ will be fixup for PpiData and PpiDescriptor pointer.\r
+ @param OldCheckingTop Top of temporary memory range. All Ppi in this range\r
+ will be fixup for PpiData and PpiDescriptor.\r
@param Fixup The address difference between\r
the new Hob list and old Hob list.\r
\r
IN UINTN OldCheckingBottom,\r
IN UINTN OldCheckingTop,\r
IN INTN Fixup\r
- )\r
-;\r
+ );\r
\r
/**\r
\r
- Install PPI services.\r
+ Install PPI services. It is implementation of EFI_PEI_SERVICE.InstallPpi.\r
\r
- @param PeiServices - Pointer to the PEI Service Table\r
- @param PpiList - Pointer to a list of PEI PPI Descriptors.\r
+ @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
+ @param PpiList Pointer to ppi array that want to be installed.\r
\r
- @retval EFI_SUCCESS - if all PPIs in PpiList are successfully installed.\r
- @retval EFI_INVALID_PARAMETER - if PpiList is NULL pointer\r
- @retval EFI_INVALID_PARAMETER - if any PPI in PpiList is not valid\r
- @retval EFI_OUT_OF_RESOURCES - if there is no more memory resource to install PPI\r
+ @retval EFI_SUCCESS if all PPIs in PpiList are successfully installed.\r
+ @retval EFI_INVALID_PARAMETER if PpiList is NULL pointer\r
+ if any PPI in PpiList is not valid\r
+ @retval EFI_OUT_OF_RESOURCES if there is no more memory resource to install PPI\r
\r
**/\r
EFI_STATUS\r
PeiInstallPpi (\r
IN CONST EFI_PEI_SERVICES **PeiServices,\r
IN CONST EFI_PEI_PPI_DESCRIPTOR *PpiList\r
- )\r
-;\r
+ );\r
\r
/**\r
\r
\r
@retval EFI_SUCCESS if the operation was successful\r
@retval EFI_INVALID_PARAMETER if OldPpi or NewPpi is NULL\r
- @retval EFI_INVALID_PARAMETER if NewPpi is not valid\r
+ if NewPpi is not valid\r
@retval EFI_NOT_FOUND if the PPI was not in the database\r
\r
**/\r
IN CONST EFI_PEI_SERVICES **PeiServices,\r
IN CONST EFI_PEI_PPI_DESCRIPTOR *OldPpi,\r
IN CONST EFI_PEI_PPI_DESCRIPTOR *NewPpi\r
- )\r
-;\r
+ );\r
\r
/**\r
\r
IN UINTN Instance,\r
IN OUT EFI_PEI_PPI_DESCRIPTOR **PpiDescriptor,\r
IN OUT VOID **Ppi\r
- )\r
-;\r
+ );\r
\r
/**\r
\r
PeiNotifyPpi (\r
IN CONST EFI_PEI_SERVICES **PeiServices,\r
IN CONST EFI_PEI_NOTIFY_DESCRIPTOR *NotifyList\r
- )\r
-;\r
+ );\r
\r
/**\r
\r
VOID\r
ProcessNotifyList (\r
IN PEI_CORE_INSTANCE *PrivateData\r
- )\r
-;\r
+ );\r
\r
/**\r
\r
IN INTN InstallStopIndex,\r
IN INTN NotifyStartIndex,\r
IN INTN NotifyStopIndex\r
- )\r
-;\r
+ );\r
\r
//\r
// Boot mode support functions\r
EFIAPI\r
PeiGetBootMode (\r
IN CONST EFI_PEI_SERVICES **PeiServices,\r
- IN OUT EFI_BOOT_MODE *BootMode\r
- )\r
-;\r
+ IN OUT EFI_BOOT_MODE *BootMode\r
+ );\r
\r
/**\r
This service enables PEIMs to update the boot mode variable.\r
PeiSetBootMode (\r
IN CONST EFI_PEI_SERVICES **PeiServices,\r
IN EFI_BOOT_MODE BootMode\r
- )\r
-;\r
+ );\r
\r
//\r
// Security support functions\r
InitializeSecurityServices (\r
IN EFI_PEI_SERVICES **PeiServices,\r
IN PEI_CORE_INSTANCE *OldCoreData\r
- )\r
-;\r
+ );\r
\r
/**\r
- Verify a Firmware volume\r
+ Verify a Firmware volume.\r
\r
@param CurrentFvAddress Pointer to the current Firmware Volume under consideration\r
\r
EFI_STATUS\r
VerifyFv (\r
IN EFI_FIRMWARE_VOLUME_HEADER *CurrentFvAddress\r
- )\r
-;\r
+ );\r
\r
/**\r
\r
IN PEI_CORE_INSTANCE *PrivateData,\r
IN EFI_PEI_FV_HANDLE VolumeHandle,\r
IN EFI_PEI_FILE_HANDLE FileHandle\r
- )\r
-;\r
+ );\r
\r
/**\r
\r
PeiGetHobList (\r
IN CONST EFI_PEI_SERVICES **PeiServices,\r
IN OUT VOID **HobList\r
- )\r
-;\r
+ );\r
\r
/**\r
Add a new HOB to the HOB List.\r
IN UINT16 Type,\r
IN UINT16 Length,\r
IN OUT VOID **Hob\r
- )\r
-;\r
+ );\r
\r
/**\r
\r
IN EFI_BOOT_MODE BootMode,\r
IN EFI_PHYSICAL_ADDRESS MemoryBegin,\r
IN UINT64 MemoryLength\r
- )\r
-;\r
+ );\r
\r
\r
//\r
@param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
@param SearchType Filter to find only files of this type.\r
Type EFI_FV_FILETYPE_ALL causes no filtering to be done.\r
- @param VolumeHandle Pointer to the FV header of the volume to search.\r
- @param FileHandle Pointer to the current file from which to begin searching.\r
+ @param FwVolHeader Pointer to the FV header of the volume to search.\r
+ @param FileHeader Pointer to the current file from which to begin searching.\r
This pointer will be updated upon return to reflect the file found.\r
@retval EFI_NOT_FOUND No files matching the search criteria were found\r
@retval EFI_SUCCESS Success to find next file in given volume\r
IN UINT8 SearchType,\r
IN EFI_PEI_FV_HANDLE FwVolHeader,\r
IN OUT EFI_PEI_FILE_HANDLE *FileHeader\r
- )\r
-;\r
+ );\r
\r
/**\r
Given the input file pointer, search for the next matching section in the\r
FFS volume.\r
\r
-\r
@param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
@param SectionType Filter to find only sections of this type.\r
- @param FileHandle Pointer to the current file to search.\r
+ @param FfsFileHeader Pointer to the current file to search.\r
@param SectionData Pointer to the Section matching SectionType in FfsFileHeader.\r
NULL if section not found\r
\r
IN EFI_SECTION_TYPE SectionType,\r
IN EFI_PEI_FILE_HANDLE FfsFileHeader,\r
IN OUT VOID **SectionData\r
- )\r
-;\r
+ );\r
\r
/**\r
search the firmware volumes by index\r
\r
- @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
- @param Instance Instance of FV to find\r
- @param VolumeHandle Pointer to found Volume.\r
+ @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
+ @param Instance Instance of FV to find\r
+ @param FwVolHeader Pointer to found Volume.\r
\r
- @retval EFI_INVALID_PARAMETER FwVolHeader is NULL\r
- @retval EFI_SUCCESS Firmware volume instance successfully found.\r
+ @retval EFI_INVALID_PARAMETER FwVolHeader is NULL\r
+ @retval EFI_SUCCESS Firmware volume instance successfully found.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiFvFindNextVolume (\r
- IN CONST EFI_PEI_SERVICES **PeiServices,\r
+ IN CONST EFI_PEI_SERVICES **PeiServices,\r
IN UINTN Instance,\r
IN OUT EFI_PEI_FV_HANDLE *FwVolHeader\r
- )\r
-;\r
+ );\r
\r
//\r
// Memory support functions\r
\r
Initialize the memory services.\r
\r
-\r
@param PrivateData PeiCore's private data structure\r
@param SecCoreData Points to a data structure containing information about the PEI core's operating\r
environment, such as the size and location of temporary RAM, the stack location and\r
IN PEI_CORE_INSTANCE *PrivateData,\r
IN CONST EFI_SEC_PEI_HAND_OFF *SecCoreData,\r
IN PEI_CORE_INSTANCE *OldCoreData\r
- )\r
-;\r
+ );\r
\r
/**\r
\r
IN CONST EFI_PEI_SERVICES **PeiServices,\r
IN EFI_PHYSICAL_ADDRESS MemoryBegin,\r
IN UINT64 MemoryLength\r
- )\r
-;\r
+ );\r
\r
/**\r
\r
IN EFI_MEMORY_TYPE MemoryType,\r
IN UINTN Pages,\r
OUT EFI_PHYSICAL_ADDRESS *Memory\r
- )\r
-;\r
+ );\r
\r
/**\r
\r
IN CONST EFI_PEI_SERVICES **PeiServices,\r
IN UINTN Size,\r
OUT VOID **Buffer\r
- )\r
-;\r
+ );\r
\r
/**\r
\r
**/\r
EFI_STATUS\r
PeiLoadImage (\r
- IN EFI_PEI_SERVICES **PeiServices,\r
+ IN CONST EFI_PEI_SERVICES **PeiServices,\r
IN EFI_PEI_FILE_HANDLE FileHandle,\r
OUT EFI_PHYSICAL_ADDRESS *EntryPoint,\r
OUT UINT32 *AuthenticationState\r
- )\r
-;\r
+ );\r
\r
/**\r
\r
IN UINT32 Instance,\r
IN CONST EFI_GUID *CallerId,\r
IN CONST EFI_STATUS_CODE_DATA *Data OPTIONAL\r
- )\r
-;\r
+ );\r
\r
/**\r
\r
EFIAPI\r
PeiResetSystem (\r
IN CONST EFI_PEI_SERVICES **PeiServices\r
- )\r
-;\r
+ );\r
\r
/**\r
\r
PeiInitializeFv (\r
IN PEI_CORE_INSTANCE *PrivateData,\r
IN CONST EFI_SEC_PEI_HAND_OFF *SecCoreData\r
- )\r
-;\r
+ );\r
\r
/**\r
Process Firmware Volum Information once FvInfoPPI install.\r
IN EFI_PEI_SERVICES **PeiServices,\r
IN EFI_PEI_NOTIFY_DESCRIPTOR *NotifyDescriptor,\r
IN VOID *Ppi\r
- )\r
-;\r
+ );\r
\r
/**\r
\r
Given the input VolumeHandle, search for the next matching name file.\r
\r
-\r
@param FileName File name to search.\r
@param VolumeHandle The current FV to search.\r
@param FileHandle Pointer to the file matching name in VolumeHandle.\r
NULL if file not found\r
\r
- @return EFI_STATUS\r
+ @retval EFI_NOT_FOUND No files matching the search criteria were found\r
+ @retval EFI_SUCCESS Success to search given file\r
\r
**/\r
EFI_STATUS\r
IN CONST EFI_GUID *FileName,\r
IN EFI_PEI_FV_HANDLE VolumeHandle,\r
OUT EFI_PEI_FILE_HANDLE *FileHandle\r
- )\r
-;\r
+ );\r
\r
/**\r
\r
PeiFfsGetFileInfo (\r
IN EFI_PEI_FILE_HANDLE FileHandle,\r
OUT EFI_FV_FILE_INFO *FileInfo\r
- )\r
-;\r
+ );\r
\r
/**\r
\r
PeiFfsGetVolumeInfo (\r
IN EFI_PEI_FV_HANDLE VolumeHandle,\r
OUT EFI_FV_INFO *VolumeInfo\r
- )\r
-;\r
+ );\r
\r
/**\r
This routine enable a PEIM to register itself to shadow when PEI Foundation\r
EFIAPI\r
PeiRegisterForShadow (\r
IN EFI_PEI_FILE_HANDLE FileHandle\r
- )\r
-;\r
+ );\r
\r
/**\r
Given the input file pointer, search for the next matching file in the\r
IN EFI_FV_FILETYPE SearchType,\r
IN OUT EFI_PEI_FILE_HANDLE *FileHandle,\r
IN OUT EFI_PEI_FV_HANDLE *AprioriFile OPTIONAL\r
- )\r
-;\r
+ );\r
\r
/**\r
+ Initialize image service that install PeiLoadFilePpi.\r
\r
- Install Pei Load File PPI.\r
-\r
-\r
- @param PrivateData Pointer to PEI_CORE_INSTANCE.\r
- @param OldCoreData Pointer to PEI_CORE_INSTANCE.\r
+ @param PrivateData Pointer to PeiCore's private data structure PEI_CORE_INSTANCE.\r
+ @param OldCoreData Pointer to Old PeiCore's private data.\r
+ If NULL, PeiCore is entered at first time, stack/heap in temporary memory.\r
+ If not NULL, PeiCore is entered at second time, stack/heap has been moved\r
+ to permenent memory.\r
\r
**/\r
VOID\r
InitializeImageServices (\r
IN PEI_CORE_INSTANCE *PrivateData,\r
IN PEI_CORE_INSTANCE *OldCoreData\r
- )\r
-;\r
+ );\r
\r
/**\r
Get Fv image from the FV type file, then install FV INFO ppi, Build FV hob.\r
\r
@param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
- @param FileHandle File handle of a Fv type file.\r
+ @param FvFileHandle File handle of a Fv type file.\r
@param AuthenticationState Pointer to attestation authentication state of image.\r
-\r
+ If return 0, means pass security checking.\r
\r
@retval EFI_NOT_FOUND FV image can't be found.\r
@retval EFI_SUCCESS Successfully to process it.\r
**/\r
EFI_STATUS\r
ProcessFvFile (\r
- IN EFI_PEI_SERVICES **PeiServices,\r
- IN EFI_PEI_FILE_HANDLE FvFileHandle,\r
- OUT UINT32 *AuthenticationState\r
+ IN CONST EFI_PEI_SERVICES **PeiServices,\r
+ IN EFI_PEI_FILE_HANDLE FvFileHandle,\r
+ OUT UINT32 *AuthenticationState\r
);\r
\r
#endif\r
projects / mirror_edk2.git / blobdiff