[mirror_edk2.git] / MdeModulePkg / Core / Pei / PeiMain.h

/** @file\r
  Definition of Pei Core Structures and Services\r
  \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
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
**/\r
\r
#ifndef _PEI_MAIN_H_\r
#define _PEI_MAIN_H_\r
\r
#include <PiPei.h>\r
#include <Ppi/DxeIpl.h>\r
#include <Ppi/MemoryDiscovered.h>\r
#include <Ppi/StatusCode.h>\r
#include <Ppi/Reset.h>\r
#include <Ppi/FirmwareVolume.h>\r
#include <Ppi/FirmwareVolumeInfo.h>\r
#include <Ppi/Decompress.h>\r
#include <Ppi/GuidedSectionExtraction.h>\r
#include <Ppi/LoadFile.h>\r
#include <Ppi/Security2.h>\r
#include <Ppi/TemporaryRamSupport.h>\r
#include <Library/DebugLib.h>\r
#include <Library/PeiCoreEntryPoint.h>\r
#include <Library/BaseLib.h>\r
#include <Library/HobLib.h>\r
#include <Library/PerformanceLib.h>\r
#include <Library/PeiServicesLib.h>\r
#include <Library/ReportStatusCodeLib.h>\r
#include <Library/PeCoffLib.h>\r
#include <Library/PeCoffGetEntryPointLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/CacheMaintenanceLib.h>\r
#include <Library/TimerLib.h>\r
#include <Library/PcdLib.h>\r
#include <IndustryStandard/PeImage.h>\r
#include <Library/PeiServicesTablePointerLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/PeiPiLib.h>\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
/// Pei Core private data structures\r
///\r
typedef union {\r
  EFI_PEI_PPI_DESCRIPTOR      *Ppi;\r
  EFI_PEI_NOTIFY_DESCRIPTOR   *Notify;\r
  VOID                        *Raw;\r
} PEI_PPI_LIST_POINTERS;\r
\r
///\r
/// PPI database structure which contains two link: PpiList and NotifyList. PpiList\r
/// is in head of PpiListPtrs array and notify is in end of PpiListPtrs.\r
///\r
typedef struct {\r
  ///\r
  /// index of end of PpiList link list.\r
  ///\r
  INTN                    PpiListEnd;\r
  ///\r
  /// index of end of notify link list.\r
  ///\r
  INTN                    NotifyListEnd;\r
  ///\r
  /// index of the dispatched notify list.\r
  ///\r
  INTN                    DispatchListEnd;\r
  ///\r
  /// index of last installed Ppi description in PpiList link list.\r
  ///\r
  INTN                    LastDispatchedInstall;\r
  ///\r
  /// index of last dispatched notify in Notify link list.\r
  /// \r
  INTN                    LastDispatchedNotify;\r
  ///\r
  /// Ppi database.\r
  ///\r
  PEI_PPI_LIST_POINTERS   PpiListPtrs[FixedPcdGet32 (PcdPeiCoreMaxPpiSupported)];\r
} PEI_PPI_DATABASE;\r
\r
\r
//\r
// PEI_CORE_FV_HANDE.PeimState\r
// Do not change these values as there is code doing math to change states.\r
// Look for Private->Fv[FvCount].PeimState[PeimCount]++;\r
//\r
#define PEIM_STATE_NOT_DISPATCHED         0x00\r
#define PEIM_STATE_DISPATCHED             0x01\r
#define PEIM_STATE_REGISITER_FOR_SHADOW   0x02\r
#define PEIM_STATE_DONE                   0x03\r
\r
typedef struct {\r
  EFI_FIRMWARE_VOLUME_HEADER          *FvHeader;\r
  UINT8                               PeimState[FixedPcdGet32 (PcdPeiCoreMaxPeimPerFv)];\r
  EFI_PEI_FILE_HANDLE                 FvFileHandles[FixedPcdGet32 (PcdPeiCoreMaxPeimPerFv)];\r
  BOOLEAN                             ScanFv;\r
} PEI_CORE_FV_HANDLE;\r
\r
#define CACHE_SETION_MAX_NUMBER       0x10\r
typedef struct {\r
  EFI_COMMON_SECTION_HEADER*          Section[CACHE_SETION_MAX_NUMBER];\r
  VOID*                               SectionData[CACHE_SETION_MAX_NUMBER];\r
  UINTN                               SectionSize[CACHE_SETION_MAX_NUMBER];\r
  UINTN                               AllSectionCount;\r
  UINTN                               SectionIndex;\r
} CACHE_SECTION_DATA;\r
\r
\r
#define PEI_CORE_HANDLE_SIGNATURE  EFI_SIGNATURE_32('P','e','i','C')\r
\r
///\r
/// Pei Core private data structure instance\r
///\r
typedef struct{\r
  UINTN                              Signature;\r
  EFI_PEI_SERVICES                   *PS;     // Point to ServiceTableShadow\r
  PEI_PPI_DATABASE                   PpiData;\r
  UINTN                              FvCount;\r
  PEI_CORE_FV_HANDLE                 Fv[FixedPcdGet32 (PcdPeiCoreMaxFvSupported)];\r
  EFI_PEI_FILE_HANDLE                CurrentFvFileHandles[FixedPcdGet32 (PcdPeiCoreMaxPeimPerFv)];\r
  UINTN                              AprioriCount;\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                            SwitchStackSignal;\r
  BOOLEAN                            PeiMemoryInstalled;\r
  EFI_PHYSICAL_ADDRESS               StackBase;\r
  UINT64                             StackSize;\r
  VOID                               *CpuIo;\r
  EFI_PEI_SECURITY2_PPI              *PrivateSecurityPpi;\r
  EFI_PEI_SERVICES                   ServiceTableShadow;\r
  EFI_PEI_PPI_DESCRIPTOR             *XipLoadFile;\r
  EFI_PHYSICAL_ADDRESS               PhysicalMemoryBegin;\r
  UINT64                             PhysicalMemoryLength;\r
  EFI_PHYSICAL_ADDRESS               FreePhysicalMemoryTop;\r
  VOID*                              ShadowedPeiCore;\r
  CACHE_SECTION_DATA                 CacheSection;\r
} PEI_CORE_INSTANCE;\r
\r
///\r
/// Pei Core Instance Data Macros\r
///\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 *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
  );\r
\r
///\r
/// Union of temporarily used function pointers (to save stack space)\r
///\r
typedef union {\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
  EFI_PEI_PPI_DESCRIPTOR       *PpiDescriptor;\r
  EFI_PEI_NOTIFY_DESCRIPTOR    *NotifyDescriptor;\r
  VOID                         *Raw;\r
} PEI_CORE_TEMP_POINTERS;\r
\r
typedef struct {\r
  CONST EFI_SEC_PEI_HAND_OFF    *SecCoreData;\r
  EFI_PEI_PPI_DESCRIPTOR        *PpiList;\r
  VOID                          *Data;\r
} PEI_CORE_PARAMETERS;\r
\r
//\r
// PeiCore function\r
//\r
/**\r
\r
  The entry routine to Pei Core, invoked by PeiMain during transition\r
  from SEC to PEI. After switching stack in the PEI core, it will restart\r
  with the old core data.\r
\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 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
  @retval EFI_NOT_FOUND  Never reach\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiCore (\r
  IN CONST EFI_SEC_PEI_HAND_OFF        *SecCoreData,\r
  IN CONST EFI_PEI_PPI_DESCRIPTOR      *PpiList,\r
  IN VOID                              *Data\r
  );\r
\r
//\r
// Dispatcher support functions\r
//\r
\r
/**\r
\r
  This is the POSTFIX version of the dependency evaluator.  When a\r
  PUSH [PPI GUID] is encountered, a pointer to the GUID is stored on\r
  the evaluation stack.  When that entry is poped from the evaluation\r
  stack, the PPI is checked if it is installed.  This method allows\r
  some time savings as not all PPIs must be checked for certain\r
  operation types (AND, OR).\r
\r
\r
  @param PeiServices            An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
  @param DependencyExpression   Pointer to a dependency expression.  The Grammar adheres to\r
                                the BNF described above and is stored in postfix notation.\r
\r
  @retval TRUE      if it is a well-formed Grammar\r
  @retval FALSE     if the dependency expression overflows the evaluation stack\r
                    if the dependency expression underflows the evaluation stack\r
                    if the dependency expression is not a well-formed Grammar.\r
\r
**/\r
BOOLEAN\r
PeimDispatchReadiness (\r
  IN EFI_PEI_SERVICES   **PeiServices,\r
  IN VOID               *DependencyExpression\r
  );\r
\r
/**\r
  Conduct PEIM dispatch.\r
\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
**/\r
VOID\r
PeiDispatcher (\r
  IN CONST EFI_SEC_PEI_HAND_OFF  *SecCoreData,\r
  IN PEI_CORE_INSTANCE           *PrivateData\r
  );\r
\r
/**\r
  Initialize the Dispatcher's data members\r
\r
  @param PrivateData     PeiCore's private data structure\r
  @param OldCoreData     Old data from SecCore\r
                         NULL if being run in non-permament memory mode.\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
\r
**/\r
VOID\r
InitializeDispatcherData (\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
  This routine parses the Dependency Expression, if available, and\r
  decides if the module can be executed.\r
\r
\r
  @param Private         PeiCore's private data structure\r
  @param FileHandle      PEIM's file handle\r
  @param PeimCount       The index of last dispatched PEIM.\r
\r
  @retval TRUE           Can be dispatched\r
  @retval FALSE          Cannot be dispatched\r
\r
**/\r
BOOLEAN\r
DepexSatisfied (\r
  IN PEI_CORE_INSTANCE          *Private,\r
  IN EFI_PEI_FILE_HANDLE        FileHandle,\r
  IN UINTN                      PeimCount\r
  );\r
\r
//\r
// PPI support functions\r
//\r
/**\r
\r
  Initialize PPI services.\r
\r
  @param PrivateData     Pointer to the PEI Core data.\r
  @param OldCoreData     Pointer to old PEI Core data. \r
                         NULL if being run in non-permament memory mode.\r
\r
**/\r
VOID\r
InitializePpiServices (\r
  IN PEI_CORE_INSTANCE   *PrivateData,\r
  IN PEI_CORE_INSTANCE   *OldCoreData\r
  );\r
\r
/**\r
\r
  Migrate the Hob list from the CAR stack to PEI installed memory.\r
\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
**/\r
VOID\r
ConvertPpiPointers (\r
  IN PEI_CORE_INSTANCE       *PrivateData,\r
  IN UINTN                   OldCheckingBottom,\r
  IN UINTN                   OldCheckingTop,\r
  IN INTN                    Fixup\r
  );\r
\r
/**\r
\r
  Install PPI services. It is implementation of EFI_PEI_SERVICE.InstallPpi.\r
\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
                                    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
EFIAPI\r
PeiInstallPpi (\r
  IN CONST EFI_PEI_SERVICES        **PeiServices,\r
  IN CONST EFI_PEI_PPI_DESCRIPTOR  *PpiList\r
  );\r
\r
/**\r
\r
  Re-Install PPI services.\r
\r
  @param PeiServices            An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
  @param OldPpi                 Pointer to the old PEI PPI Descriptors.\r
  @param NewPpi                 Pointer to the new PEI PPI Descriptors.\r
\r
  @retval EFI_SUCCESS           if the operation was successful\r
  @retval EFI_INVALID_PARAMETER if OldPpi or NewPpi is NULL\r
                                if NewPpi is not valid\r
  @retval EFI_NOT_FOUND         if the PPI was not in the database\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiReInstallPpi (\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
  Locate a given named PPI.\r
\r
\r
  @param PeiServices     An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
  @param Guid            Pointer to GUID of the PPI.\r
  @param Instance        Instance Number to discover.\r
  @param PpiDescriptor   Pointer to reference the found descriptor. If not NULL,\r
                         returns a pointer to the descriptor (includes flags, etc)\r
  @param Ppi             Pointer to reference the found PPI\r
\r
  @retval EFI_SUCCESS   if the PPI is in the database\r
  @retval EFI_NOT_FOUND if the PPI is not in the database\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiLocatePpi (\r
  IN CONST EFI_PEI_SERVICES      **PeiServices,\r
  IN CONST EFI_GUID              *Guid,\r
  IN UINTN                       Instance,\r
  IN OUT EFI_PEI_PPI_DESCRIPTOR  **PpiDescriptor,\r
  IN OUT VOID                    **Ppi\r
  );\r
\r
/**\r
\r
  Install a notification for a given PPI.\r
\r
\r
  @param PeiServices            An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
  @param NotifyList             Pointer to list of Descriptors to notify upon.\r
\r
  @retval EFI_SUCCESS           if successful\r
  @retval EFI_OUT_OF_RESOURCES  if no space in the database\r
  @retval EFI_INVALID_PARAMETER if not a good decriptor\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiNotifyPpi (\r
  IN CONST EFI_PEI_SERVICES           **PeiServices,\r
  IN CONST EFI_PEI_NOTIFY_DESCRIPTOR  *NotifyList\r
  );\r
\r
/**\r
\r
  Process the Notify List at dispatch level.\r
\r
  @param PrivateData  PeiCore's private data structure.\r
\r
**/\r
VOID\r
ProcessNotifyList (\r
  IN PEI_CORE_INSTANCE  *PrivateData\r
  );\r
\r
/**\r
\r
  Dispatch notifications.\r
\r
  @param PrivateData        PeiCore's private data structure\r
  @param NotifyType         Type of notify to fire.\r
  @param InstallStartIndex  Install Beginning index.\r
  @param InstallStopIndex   Install Ending index.\r
  @param NotifyStartIndex   Notify Beginning index.\r
  @param NotifyStopIndex    Notify Ending index.\r
\r
**/\r
VOID\r
DispatchNotify (\r
  IN PEI_CORE_INSTANCE  *PrivateData,\r
  IN UINTN               NotifyType,\r
  IN INTN                InstallStartIndex,\r
  IN INTN                InstallStopIndex,\r
  IN INTN                NotifyStartIndex,\r
  IN INTN                NotifyStopIndex\r
  );\r
\r
//\r
// Boot mode support functions\r
//\r
/**\r
  This service enables PEIMs to ascertain the present value of the boot mode.\r
\r
  @param PeiServices            An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
  @param BootMode               A pointer to contain the value of the boot mode.\r
\r
  @retval EFI_SUCCESS           The boot mode was returned successfully.\r
  @retval EFI_INVALID_PARAMETER BootMode is NULL.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiGetBootMode (\r
  IN CONST EFI_PEI_SERVICES  **PeiServices,\r
  IN OUT   EFI_BOOT_MODE     *BootMode\r
  );\r
\r
/**\r
  This service enables PEIMs to update the boot mode variable.\r
\r
\r
  @param PeiServices     An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
  @param BootMode        The value of the boot mode to set.\r
\r
  @return EFI_SUCCESS    The value was successfully updated\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiSetBootMode (\r
  IN CONST EFI_PEI_SERVICES  **PeiServices,\r
  IN EFI_BOOT_MODE     BootMode\r
  );\r
\r
//\r
// Security support functions\r
//\r
/**\r
\r
  Initialize the security services.\r
\r
  @param PeiServices     An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
  @param OldCoreData     Pointer to the old core data.\r
                         NULL if being run in non-permament memory mode.\r
\r
**/\r
VOID\r
InitializeSecurityServices (\r
  IN EFI_PEI_SERVICES  **PeiServices,\r
  IN PEI_CORE_INSTANCE *OldCoreData\r
  );\r
\r
/**\r
  Verify a Firmware volume.\r
\r
  @param CurrentFvAddress           Pointer to the current Firmware Volume under consideration\r
\r
  @retval EFI_SUCCESS               Firmware Volume is legal\r
  @retval EFI_SECURITY_VIOLATION    Firmware Volume fails integrity test\r
\r
**/\r
EFI_STATUS\r
VerifyFv (\r
  IN EFI_FIRMWARE_VOLUME_HEADER  *CurrentFvAddress\r
  );\r
\r
/**\r
\r
  Provide a callout to the security verification service.\r
\r
\r
  @param PrivateData     PeiCore's private data structure\r
  @param VolumeHandle    Handle of FV\r
  @param FileHandle      Handle of PEIM's ffs\r
\r
  @retval EFI_SUCCESS              Image is OK\r
  @retval EFI_SECURITY_VIOLATION   Image is illegal\r
\r
**/\r
EFI_STATUS\r
VerifyPeim (\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
  Gets the pointer to the HOB List.\r
\r
\r
  @param PeiServices                   An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
  @param HobList                       Pointer to the HOB List.\r
\r
  @retval EFI_SUCCESS                  Get the pointer of HOB List\r
  @retval EFI_NOT_AVAILABLE_YET        the HOB List is not yet published\r
  @retval EFI_INVALID_PARAMETER        HobList is NULL (in debug mode)\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiGetHobList (\r
  IN CONST EFI_PEI_SERVICES  **PeiServices,\r
  IN OUT VOID          **HobList\r
  );\r
\r
/**\r
  Add a new HOB to the HOB List.\r
\r
  @param PeiServices        An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
  @param Type               Type of the new HOB.\r
  @param Length             Length of the new HOB to allocate.\r
  @param Hob                Pointer to the new HOB.\r
\r
  @return  EFI_SUCCESS           Success to create hob.\r
  @retval  EFI_INVALID_PARAMETER if Hob is NULL\r
  @retval  EFI_NOT_AVAILABLE_YET if HobList is still not available.\r
  @retval  EFI_OUT_OF_RESOURCES  if there is no more memory to grow the Hoblist.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiCreateHob (\r
  IN CONST EFI_PEI_SERVICES  **PeiServices,\r
  IN UINT16            Type,\r
  IN UINT16            Length,\r
  IN OUT VOID          **Hob\r
  );\r
\r
/**\r
\r
  Builds a Handoff Information Table HOB\r
\r
  @param BootMode        - Current Bootmode\r
  @param MemoryBegin     - Start Memory Address.\r
  @param MemoryLength    - Length of Memory.\r
\r
  @return EFI_SUCCESS Always success to initialize HOB.\r
\r
**/\r
EFI_STATUS\r
PeiCoreBuildHobHandoffInfoTable (\r
  IN EFI_BOOT_MODE         BootMode,\r
  IN EFI_PHYSICAL_ADDRESS  MemoryBegin,\r
  IN UINT64                MemoryLength\r
  );\r
\r
\r
//\r
// FFS Fw Volume support functions\r
//\r
/**\r
  Given the input file pointer, search for the next matching file in the\r
  FFS volume as defined by SearchType. The search starts from FileHeader inside\r
  the Firmware Volume defined by FwVolHeader.\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 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
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiFfsFindNextFile (\r
  IN CONST EFI_PEI_SERVICES      **PeiServices,\r
  IN UINT8                       SearchType,\r
  IN EFI_PEI_FV_HANDLE           FwVolHeader,\r
  IN OUT EFI_PEI_FILE_HANDLE     *FileHeader\r
  );\r
\r
/**\r
  Given the input file pointer, search for the next matching section in the\r
  FFS volume.\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 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
  @retval EFI_NOT_FOUND  No files matching the search criteria were found\r
  @retval EFI_SUCCESS    Success to find section data in given file\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiFfsFindSectionData (\r
  IN CONST EFI_PEI_SERVICES      **PeiServices,\r
  IN EFI_SECTION_TYPE            SectionType,\r
  IN EFI_PEI_FILE_HANDLE         FfsFileHeader,\r
  IN OUT VOID                    **SectionData\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 FwVolHeader            Pointer to found Volume.\r
\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 UINTN                           Instance,\r
  IN OUT EFI_PEI_FV_HANDLE           *FwVolHeader\r
  );\r
\r
//\r
// Memory support functions\r
//\r
/**\r
\r
  Initialize the memory services.\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
                         the BFV location.\r
  @param OldCoreData     Pointer to the PEI Core data.\r
                         NULL if being run in non-permament memory mode.\r
\r
**/\r
VOID\r
InitializeMemoryServices (\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
  Install the permanent memory is now available.\r
  Creates HOB (PHIT and Stack).\r
\r
  @param PeiServices     An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
  @param MemoryBegin     Start of memory address.\r
  @param MemoryLength    Length of memory.\r
\r
  @return EFI_SUCCESS Always success.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiInstallPeiMemory (\r
  IN CONST EFI_PEI_SERVICES      **PeiServices,\r
  IN EFI_PHYSICAL_ADDRESS  MemoryBegin,\r
  IN UINT64                MemoryLength\r
  );\r
\r
/**\r
\r
  Memory allocation service on permanent memory,\r
  not usable prior to the memory installation.\r
\r
\r
  @param PeiServices               An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
  @param MemoryType                Type of memory to allocate.\r
  @param Pages                     Number of pages to allocate.\r
  @param Memory                    Pointer of memory allocated.\r
\r
  @retval EFI_SUCCESS              The allocation was successful\r
  @retval EFI_INVALID_PARAMETER    Only AllocateAnyAddress is supported.\r
  @retval EFI_NOT_AVAILABLE_YET    Called with permanent memory not available\r
  @retval EFI_OUT_OF_RESOURCES     There is not enough HOB heap to satisfy the requirement\r
                                   to allocate the number of pages.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiAllocatePages (\r
  IN CONST EFI_PEI_SERVICES           **PeiServices,\r
  IN EFI_MEMORY_TYPE            MemoryType,\r
  IN UINTN                      Pages,\r
  OUT EFI_PHYSICAL_ADDRESS      *Memory\r
  );\r
\r
/**\r
\r
  Memory allocation service on the CAR.\r
\r
\r
  @param PeiServices        An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
  @param Size               Amount of memory required\r
  @param Buffer             Address of pointer to the buffer\r
\r
  @retval EFI_SUCCESS              The allocation was successful\r
  @retval EFI_OUT_OF_RESOURCES     There is not enough heap to satisfy the requirement\r
                                   to allocate the requested size.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiAllocatePool (\r
  IN CONST EFI_PEI_SERVICES           **PeiServices,\r
  IN UINTN                      Size,\r
  OUT VOID                      **Buffer\r
  );\r
\r
/**\r
\r
  Routine for load image file.\r
\r
\r
  @param PeiServices            An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
  @param FileHandle             Pointer to the FFS file header of the image.\r
  @param EntryPoint             Pointer to entry point of specified image file for output.\r
  @param AuthenticationState    Pointer to attestation authentication state of image.\r
\r
  @retval EFI_SUCCESS     Image is successfully loaded.\r
  @retval EFI_NOT_FOUND   Fail to locate necessary PPI\r
  @retval Others          Fail to load file.\r
\r
**/\r
EFI_STATUS\r
PeiLoadImage (\r
  IN  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
  Core version of the Status Code reporter\r
\r
\r
  @param PeiServices            An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
  @param CodeType               Type of Status Code.\r
  @param Value                  Value to output for Status Code.\r
  @param Instance               Instance Number of this status code.\r
  @param CallerId               ID of the caller of this status code.\r
  @param Data                   Optional data associated with this status code.\r
\r
  @retval EFI_SUCCESS             if status code is successfully reported\r
  @retval EFI_NOT_AVAILABLE_YET   if StatusCodePpi has not been installed\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiReportStatusCode (\r
  IN CONST EFI_PEI_SERVICES         **PeiServices,\r
  IN EFI_STATUS_CODE_TYPE     CodeType,\r
  IN EFI_STATUS_CODE_VALUE    Value,\r
  IN UINT32                   Instance,\r
  IN CONST EFI_GUID                 *CallerId,\r
  IN CONST EFI_STATUS_CODE_DATA     *Data OPTIONAL\r
  );\r
\r
/**\r
\r
  Core version of the Reset System\r
\r
\r
  @param PeiServices                An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
\r
  @retval EFI_NOT_AVAILABLE_YET     PPI not available yet.\r
  @retval EFI_DEVICE_ERROR          Did not reset system.\r
                                    Otherwise, resets the system.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiResetSystem (\r
  IN CONST EFI_PEI_SERVICES   **PeiServices\r
  );\r
\r
/**\r
\r
  Initialize PeiCore Fv List.\r
\r
\r
  @param PrivateData     - Pointer to PEI_CORE_INSTANCE.\r
  @param SecCoreData     - Pointer to EFI_SEC_PEI_HAND_OFF.\r
\r
**/\r
VOID\r
PeiInitializeFv (\r
  IN  PEI_CORE_INSTANCE           *PrivateData,\r
  IN CONST EFI_SEC_PEI_HAND_OFF   *SecCoreData\r
  );\r
\r
/**\r
  Process Firmware Volum Information once FvInfoPPI install.\r
\r
  @param PeiServices       An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
  @param NotifyDescriptor  Address of the notification descriptor data structure.\r
  @param Ppi               Address of the PPI that was installed.\r
\r
  @retval EFI_SUCCESS if the interface could be successfully installed\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
FirmwareVolmeInfoPpiNotifyCallback (\r
  IN EFI_PEI_SERVICES              **PeiServices,\r
  IN EFI_PEI_NOTIFY_DESCRIPTOR     *NotifyDescriptor,\r
  IN VOID                          *Ppi\r
  );\r
\r
/**\r
\r
  Given the input VolumeHandle, search for the next matching name file.\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
  @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
EFIAPI\r
PeiFfsFindFileByName (\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
  Returns information about a specific file.\r
\r
\r
  @param FileHandle         The handle to file.\r
  @param FileInfo           Pointer to the file information.\r
\r
  @retval EFI_INVALID_PARAMETER Invalid FileHandle or FileInfo.\r
  @retval EFI_SUCCESS           Success to collect file info.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiFfsGetFileInfo (\r
  IN EFI_PEI_FILE_HANDLE  FileHandle,\r
  OUT EFI_FV_FILE_INFO    *FileInfo\r
  );\r
\r
/**\r
\r
  Collect information of given Fv Volume.\r
\r
  @param VolumeHandle           The handle to Fv Volume.\r
  @param VolumeInfo             The pointer to volume information.\r
\r
  @retval EFI_INVALID_PARAMETER VolumeInfo is NULL\r
  @retval EFI_SUCCESS           Success to collect fv info.\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiFfsGetVolumeInfo (\r
  IN EFI_PEI_FV_HANDLE  VolumeHandle,\r
  OUT EFI_FV_INFO       *VolumeInfo\r
  );\r
\r
/**\r
  This routine enable a PEIM to register itself to shadow when PEI Foundation\r
  discovery permanent memory.\r
\r
  @param FileHandle             File handle of a PEIM.\r
\r
  @retval EFI_NOT_FOUND         The file handle doesn't point to PEIM itself.\r
  @retval EFI_ALREADY_STARTED   Indicate that the PEIM has been registered itself.\r
  @retval EFI_SUCCESS           Successfully to register itself.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiRegisterForShadow (\r
  IN EFI_PEI_FILE_HANDLE       FileHandle\r
  );\r
\r
/**\r
  Given the input file pointer, search for the next matching file in the\r
  FFS volume as defined by SearchType. The search starts from FileHeader inside\r
  the Firmware Volume defined by FwVolHeader.\r
\r
\r
  @param FvHandle        Pointer to the FV header of the volume to search\r
  @param FileName        File name\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 FileHandle      This parameter must point to a valid FFS volume.\r
  @param AprioriFile     Pointer to AprioriFile image in this FV if has\r
\r
  @return 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
PeiFindFileEx (\r
  IN  CONST EFI_PEI_FV_HANDLE        FvHandle,\r
  IN  CONST EFI_GUID                 *FileName,   OPTIONAL\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
  Initialize image service that install PeiLoadFilePpi.\r
\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
  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 FvFileHandle         File handle of a Fv type file.\r
  @param AuthenticationState  Pointer to attestation authentication state of image.\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
**/\r
EFI_STATUS\r
ProcessFvFile (\r
  IN  EFI_PEI_SERVICES      **PeiServices,\r
  IN  EFI_PEI_FILE_HANDLE   FvFileHandle,\r
  OUT UINT32                *AuthenticationState\r
  );\r
\r
#endif\r