[mirror_edk2.git] / MdePkg / Library / PeiServicesLib / PeiServicesLib.c

/** @file\r
  Implementation for PEI Services Library.\r
\r
  Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include <PiPei.h>\r
\r
#include <Ppi/FirmwareVolumeInfo.h>\r
#include <Ppi/FirmwareVolumeInfo2.h>\r
#include <Guid/FirmwareFileSystem2.h>\r
\r
#include <Library/PeiServicesLib.h>\r
#include <Library/PeiServicesTablePointerLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/BaseMemoryLib.h>\r
\r
/**\r
  This service enables a given PEIM to register an interface into the PEI Foundation.\r
\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.\r
  @retval EFI_INVALID_PARAMETER Any of the PEI PPI 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
EFI_STATUS\r
EFIAPI\r
PeiServicesInstallPpi (\r
  IN CONST EFI_PEI_PPI_DESCRIPTOR  *PpiList\r
  )\r
{\r
  CONST EFI_PEI_SERVICES  **PeiServices;\r
\r
  PeiServices = GetPeiServicesTablePointer ();\r
  return (*PeiServices)->InstallPpi (PeiServices, PpiList);\r
}\r
\r
/**\r
  This service enables PEIMs to replace an entry in the PPI database with an alternate entry.\r
\r
  @param  OldPpi                The pointer to the old PEI PPI Descriptors.\r
  @param  NewPpi                The pointer to the new PEI PPI Descriptors.\r
\r
  @retval EFI_SUCCESS           The interface was successfully installed.\r
  @retval EFI_INVALID_PARAMETER The OldPpi or NewPpi is NULL.\r
  @retval EFI_INVALID_PARAMETER Any of the PEI PPI 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
  @retval EFI_NOT_FOUND         The PPI for which the reinstallation was requested has not been\r
                                installed.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiServicesReInstallPpi (\r
  IN CONST EFI_PEI_PPI_DESCRIPTOR  *OldPpi,\r
  IN CONST EFI_PEI_PPI_DESCRIPTOR  *NewPpi\r
  )\r
{\r
  CONST EFI_PEI_SERVICES  **PeiServices;\r
\r
  PeiServices = GetPeiServicesTablePointer ();\r
  return (*PeiServices)->ReInstallPpi (PeiServices, OldPpi, NewPpi);\r
}\r
\r
/**\r
  This service enables PEIMs to discover a given instance of an interface.\r
\r
  @param  Guid                  A pointer to the GUID whose corresponding interface needs to be\r
                                found.\r
  @param  Instance              The N-th instance of the interface that is required.\r
  @param  PpiDescriptor         A pointer to instance of the EFI_PEI_PPI_DESCRIPTOR.\r
  @param  Ppi                   A pointer to the instance of the interface.\r
\r
  @retval EFI_SUCCESS           The interface was successfully returned.\r
  @retval EFI_NOT_FOUND         The PPI descriptor is not found in the database.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiServicesLocatePpi (\r
  IN CONST EFI_GUID              *Guid,\r
  IN UINTN                       Instance,\r
  IN OUT EFI_PEI_PPI_DESCRIPTOR  **PpiDescriptor  OPTIONAL,\r
  IN OUT VOID                    **Ppi\r
  )\r
{\r
  CONST EFI_PEI_SERVICES  **PeiServices;\r
\r
  PeiServices = GetPeiServicesTablePointer ();\r
  return (*PeiServices)->LocatePpi (PeiServices, Guid, Instance, PpiDescriptor, Ppi);\r
}\r
\r
/**\r
  This service enables PEIMs to register a given service to be invoked when another service is\r
  installed or reinstalled.\r
\r
  @param  NotifyList            A pointer to the list of notification interfaces\r
                                that the caller shall install.\r
\r
  @retval EFI_SUCCESS           The interface was successfully installed.\r
  @retval EFI_INVALID_PARAMETER The NotifyList pointer is NULL.\r
  @retval EFI_INVALID_PARAMETER Any of the PEI notify descriptors in the list do\r
                                 not have the EFI_PEI_PPI_DESCRIPTOR_NOTIFY_TYPES\r
                                 bit set in the Flags field.\r
  @retval EFI_OUT_OF_RESOURCES  There is no additional space in the PPI database.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiServicesNotifyPpi (\r
  IN CONST EFI_PEI_NOTIFY_DESCRIPTOR  *NotifyList\r
  )\r
{\r
  CONST EFI_PEI_SERVICES  **PeiServices;\r
\r
  PeiServices = GetPeiServicesTablePointer ();\r
  return (*PeiServices)->NotifyPpi (PeiServices, NotifyList);\r
}\r
\r
/**\r
  This service enables PEIMs to ascertain the present value of the boot mode.\r
\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
PeiServicesGetBootMode (\r
  OUT EFI_BOOT_MODE  *BootMode\r
  )\r
{\r
  CONST EFI_PEI_SERVICES  **PeiServices;\r
\r
  PeiServices = GetPeiServicesTablePointer ();\r
  return (*PeiServices)->GetBootMode (PeiServices, BootMode);\r
}\r
\r
/**\r
  This service enables PEIMs to update the boot mode variable.\r
\r
  @param  BootMode              The value of the boot mode to set.\r
\r
  @retval EFI_SUCCESS           The value was successfully updated\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiServicesSetBootMode (\r
  IN EFI_BOOT_MODE  BootMode\r
  )\r
{\r
  CONST EFI_PEI_SERVICES  **PeiServices;\r
\r
  PeiServices = GetPeiServicesTablePointer ();\r
  return (*PeiServices)->SetBootMode (PeiServices, BootMode);\r
}\r
\r
/**\r
  This service enables a PEIM to ascertain the address of the list of HOBs in memory.\r
\r
  @param  HobList               A pointer to the list of HOBs that the PEI Foundation\r
                                will initialize.\r
\r
  @retval EFI_SUCCESS           The list was successfully returned.\r
  @retval EFI_NOT_AVAILABLE_YET The HOB list is not yet published.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiServicesGetHobList (\r
  OUT VOID  **HobList\r
  )\r
{\r
  CONST EFI_PEI_SERVICES  **PeiServices;\r
\r
  PeiServices = GetPeiServicesTablePointer ();\r
  return (*PeiServices)->GetHobList (PeiServices, HobList);\r
}\r
\r
/**\r
  This service enables PEIMs to create various types of HOBs.\r
\r
  @param  Type                  The type of HOB to be installed.\r
  @param  Length                The length of the HOB to be added.\r
  @param  Hob                   The address of a pointer that will contain the\r
                                HOB header.\r
\r
  @retval EFI_SUCCESS           The HOB was successfully created.\r
  @retval EFI_OUT_OF_RESOURCES  There is no additional space for HOB creation.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiServicesCreateHob (\r
  IN UINT16  Type,\r
  IN UINT16  Length,\r
  OUT VOID   **Hob\r
  )\r
{\r
  CONST EFI_PEI_SERVICES  **PeiServices;\r
\r
  PeiServices = GetPeiServicesTablePointer ();\r
  return (*PeiServices)->CreateHob (PeiServices, Type, Length, Hob);\r
}\r
\r
/**\r
  This service enables PEIMs to discover additional firmware volumes.\r
\r
  @param  Instance              This instance of the firmware volume to find.  The\r
                                value 0 is the Boot Firmware Volume (BFV).\r
  @param  VolumeHandle          Handle of the firmware volume header of the volume\r
                                to return.\r
\r
  @retval EFI_SUCCESS           The volume was found.\r
  @retval EFI_NOT_FOUND         The volume was not found.\r
  @retval EFI_INVALID_PARAMETER FwVolHeader is NULL.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiServicesFfsFindNextVolume (\r
  IN UINTN                  Instance,\r
  IN OUT EFI_PEI_FV_HANDLE  *VolumeHandle\r
  )\r
{\r
  CONST EFI_PEI_SERVICES  **PeiServices;\r
\r
  PeiServices = GetPeiServicesTablePointer ();\r
  return (*PeiServices)->FfsFindNextVolume (PeiServices, Instance, VolumeHandle);\r
}\r
\r
/**\r
  This service enables PEIMs to discover additional firmware files.\r
\r
  @param  SearchType            A filter to find files only of this type.\r
  @param  VolumeHandle          The pointer to the firmware volume header of the\r
                                volume to search. This parameter must point to a\r
                                valid FFS volume.\r
  @param  FileHandle            Handle of the current file from which to begin searching.\r
\r
  @retval EFI_SUCCESS           The file was found.\r
  @retval EFI_NOT_FOUND         The file was not found.\r
  @retval EFI_NOT_FOUND         The header checksum was not zero.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiServicesFfsFindNextFile (\r
  IN EFI_FV_FILETYPE          SearchType,\r
  IN EFI_PEI_FV_HANDLE        VolumeHandle,\r
  IN OUT EFI_PEI_FILE_HANDLE  *FileHandle\r
  )\r
{\r
  CONST EFI_PEI_SERVICES  **PeiServices;\r
\r
  PeiServices = GetPeiServicesTablePointer ();\r
  return (*PeiServices)->FfsFindNextFile (PeiServices, SearchType, VolumeHandle, FileHandle);\r
}\r
\r
/**\r
  This service enables PEIMs to discover sections of a given type within a valid FFS file.\r
\r
  @param  SectionType           The value of the section type to find.\r
  @param  FileHandle            A pointer to the file header that contains the set\r
                                of sections to be searched.\r
  @param  SectionData           A pointer to the discovered section, if successful.\r
\r
  @retval EFI_SUCCESS           The section was found.\r
  @retval EFI_NOT_FOUND         The section was not found.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiServicesFfsFindSectionData (\r
  IN EFI_SECTION_TYPE     SectionType,\r
  IN EFI_PEI_FILE_HANDLE  FileHandle,\r
  OUT VOID                **SectionData\r
  )\r
{\r
  CONST EFI_PEI_SERVICES  **PeiServices;\r
\r
  PeiServices = GetPeiServicesTablePointer ();\r
  return (*PeiServices)->FfsFindSectionData (PeiServices, SectionType, FileHandle, SectionData);\r
}\r
\r
/**\r
  This service enables PEIMs to discover sections of a given instance and type within a valid FFS file.\r
\r
  @param  SectionType           The value of the section type to find.\r
  @param  SectionInstance       Section instance to find.\r
  @param  FileHandle            A pointer to the file header that contains the set\r
                                of sections to be searched.\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
EFI_STATUS\r
EFIAPI\r
PeiServicesFfsFindSectionData3 (\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
  CONST EFI_PEI_SERVICES  **PeiServices;\r
\r
  PeiServices = GetPeiServicesTablePointer ();\r
  return (*PeiServices)->FindSectionData3 (PeiServices, SectionType, SectionInstance, FileHandle, SectionData, AuthenticationStatus);\r
}\r
\r
/**\r
  This service enables PEIMs to register the permanent memory configuration\r
  that has been initialized with the PEI Foundation.\r
\r
  @param  MemoryBegin           The value of a region of installed memory.\r
  @param  MemoryLength          The corresponding length of a region of installed memory.\r
\r
  @retval EFI_SUCCESS           The region was successfully installed in a HOB.\r
  @retval EFI_INVALID_PARAMETER MemoryBegin and MemoryLength are illegal for this system.\r
  @retval EFI_OUT_OF_RESOURCES  There is no additional space for HOB creation.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiServicesInstallPeiMemory (\r
  IN EFI_PHYSICAL_ADDRESS  MemoryBegin,\r
  IN UINT64                MemoryLength\r
  )\r
{\r
  CONST EFI_PEI_SERVICES  **PeiServices;\r
\r
  PeiServices = GetPeiServicesTablePointer ();\r
  return (*PeiServices)->InstallPeiMemory (PeiServices, MemoryBegin, MemoryLength);\r
}\r
\r
/**\r
  This service enables PEIMs to allocate memory.\r
\r
  @param  MemoryType            Type of memory to allocate.\r
  @param  Pages                 The number of pages to allocate.\r
  @param  Memory                Pointer of memory allocated.\r
\r
  @retval EFI_SUCCESS           The memory range was successfully allocated.\r
  @retval EFI_INVALID_PARAMETER Type is not equal to EfiLoaderCode, EfiLoaderData, EfiRuntimeServicesCode,\r
                                EfiRuntimeServicesData, EfiBootServicesCode, EfiBootServicesData,\r
                                EfiACPIReclaimMemory, EfiReservedMemoryType, or EfiACPIMemoryNVS.\r
  @retval EFI_OUT_OF_RESOURCES  The pages could not be allocated.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiServicesAllocatePages (\r
  IN EFI_MEMORY_TYPE        MemoryType,\r
  IN UINTN                  Pages,\r
  OUT EFI_PHYSICAL_ADDRESS  *Memory\r
  )\r
{\r
  CONST EFI_PEI_SERVICES  **PeiServices;\r
\r
  PeiServices = GetPeiServicesTablePointer ();\r
  return (*PeiServices)->AllocatePages (PeiServices, MemoryType, Pages, Memory);\r
}\r
\r
/**\r
  This service enables PEIMs to free memory.\r
\r
  @param Memory                 Memory to be freed.\r
  @param Pages                  The number of 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
EFI_STATUS\r
EFIAPI\r
PeiServicesFreePages (\r
  IN EFI_PHYSICAL_ADDRESS  Memory,\r
  IN UINTN                 Pages\r
  )\r
{\r
  CONST EFI_PEI_SERVICES  **PeiServices;\r
\r
  PeiServices = GetPeiServicesTablePointer ();\r
  return (*PeiServices)->FreePages (PeiServices, Memory, Pages);\r
}\r
\r
/**\r
  This service allocates memory from the Hand-Off Block (HOB) heap.\r
\r
  @param  Size                  The number of bytes to allocate from the pool.\r
  @param  Buffer                If the call succeeds, a pointer to a pointer to\r
                                the allocate buffer; otherwise, undefined.\r
\r
  @retval EFI_SUCCESS           The allocation was successful\r
  @retval EFI_OUT_OF_RESOURCES  There is not enough heap to allocate the requested size.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiServicesAllocatePool (\r
  IN UINTN  Size,\r
  OUT VOID  **Buffer\r
  )\r
{\r
  CONST EFI_PEI_SERVICES  **PeiServices;\r
\r
  PeiServices = GetPeiServicesTablePointer ();\r
  return (*PeiServices)->AllocatePool (PeiServices, Size, Buffer);\r
}\r
\r
/**\r
  Resets the entire platform.\r
\r
  @retval EFI_SUCCESS           The function completed successfully.\r
  @retval EFI_NOT_AVAILABLE_YET The service has not been installed yet.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiServicesResetSystem (\r
  VOID\r
  )\r
{\r
  CONST EFI_PEI_SERVICES  **PeiServices;\r
\r
  PeiServices = GetPeiServicesTablePointer ();\r
  return (*PeiServices)->ResetSystem (PeiServices);\r
}\r
\r
/**\r
  This service is a wrapper for the PEI Service RegisterForShadow(), except the\r
  pointer to the PEI Services Table has been removed.  See the Platform\r
  Initialization Pre-EFI Initialization Core Interface Specification for details.\r
\r
  @param FileHandle             PEIM's file handle. Must be the currently\r
                                executing PEIM.\r
\r
  @retval EFI_SUCCESS           The PEIM was successfully registered for\r
                                shadowing.\r
\r
  @retval EFI_ALREADY_STARTED   The PEIM was previously\r
                                registered for shadowing.\r
\r
  @retval EFI_NOT_FOUND         The FileHandle does not refer to a\r
                                valid file handle.\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiServicesRegisterForShadow (\r
  IN  EFI_PEI_FILE_HANDLE  FileHandle\r
  )\r
{\r
  return (*GetPeiServicesTablePointer ())->RegisterForShadow (FileHandle);\r
}\r
\r
/**\r
  This service is a wrapper for the PEI Service FfsGetFileInfo(), except the pointer to the PEI Services\r
  Table has been removed.  See the Platform Initialization Pre-EFI Initialization Core Interface\r
  Specification for details.\r
\r
  @param FileHandle              The handle of the file.\r
\r
  @param FileInfo                 Upon exit, points to the file's\r
                                  information.\r
\r
  @retval EFI_SUCCESS             File information returned.\r
\r
  @retval EFI_INVALID_PARAMETER   If FileHandle does not\r
                                  represent a valid file.\r
\r
  @retval EFI_INVALID_PARAMETER   FileInfo is NULL.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiServicesFfsGetFileInfo (\r
  IN CONST  EFI_PEI_FILE_HANDLE  FileHandle,\r
  OUT EFI_FV_FILE_INFO           *FileInfo\r
  )\r
{\r
  return (*GetPeiServicesTablePointer ())->FfsGetFileInfo (FileHandle, FileInfo);\r
}\r
\r
/**\r
  This service is a wrapper for the PEI Service FfsGetFileInfo2(), except the pointer to the PEI Services\r
  Table has been removed. See the Platform Initialization Pre-EFI Initialization Core Interface\r
  Specification for details.\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 returned.\r
  @retval EFI_INVALID_PARAMETER   If FileHandle does not\r
                                  represent a valid file.\r
  @retval EFI_INVALID_PARAMETER   FileInfo is NULL.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiServicesFfsGetFileInfo2 (\r
  IN CONST  EFI_PEI_FILE_HANDLE  FileHandle,\r
  OUT EFI_FV_FILE_INFO2          *FileInfo\r
  )\r
{\r
  return (*GetPeiServicesTablePointer ())->FfsGetFileInfo2 (FileHandle, FileInfo);\r
}\r
\r
/**\r
  This service is a wrapper for the PEI Service FfsFindByName(), except the pointer to the PEI Services\r
  Table has been removed.  See the Platform Initialization Pre-EFI Initialization Core Interface\r
  Specification for details.\r
\r
  @param FileName                 A pointer to the name of the file to\r
                                  find within the firmware volume.\r
\r
  @param VolumeHandle             The firmware volume to search FileHandle\r
                                  Upon exit, points to the found file's\r
                                  handle or NULL if it could not be found.\r
  @param FileHandle               The pointer to found file handle\r
\r
  @retval EFI_SUCCESS             File was found.\r
\r
  @retval EFI_NOT_FOUND           File was not found.\r
\r
  @retval EFI_INVALID_PARAMETER   VolumeHandle or FileHandle or\r
                                  FileName was NULL.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiServicesFfsFindFileByName (\r
  IN CONST  EFI_GUID             *FileName,\r
  IN CONST  EFI_PEI_FV_HANDLE    VolumeHandle,\r
  OUT       EFI_PEI_FILE_HANDLE  *FileHandle\r
  )\r
{\r
  return (*GetPeiServicesTablePointer ())->FfsFindFileByName (FileName, VolumeHandle, FileHandle);\r
}\r
\r
/**\r
  This service is a wrapper for the PEI Service FfsGetVolumeInfo(), except the pointer to the PEI Services\r
  Table has been removed.  See the Platform Initialization Pre-EFI Initialization Core Interface\r
  Specification for details.\r
\r
  @param VolumeHandle             Handle of the volume.\r
\r
  @param VolumeInfo               Upon exit, points to the volume's\r
                                  information.\r
\r
  @retval EFI_SUCCESS             File information returned.\r
\r
  @retval EFI_INVALID_PARAMETER   If FileHandle does not\r
                                  represent a valid file.\r
\r
  @retval EFI_INVALID_PARAMETER   If FileInfo is NULL.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiServicesFfsGetVolumeInfo (\r
  IN  EFI_PEI_FV_HANDLE  VolumeHandle,\r
  OUT EFI_FV_INFO        *VolumeInfo\r
  )\r
{\r
  return (*GetPeiServicesTablePointer ())->FfsGetVolumeInfo (VolumeHandle, VolumeInfo);\r
}\r
\r
/**\r
  Install a EFI_PEI_FIRMWARE_VOLUME_INFO(2)_PPI instance so the PEI Core will be notified about a new firmware volume.\r
\r
  This function allocates, initializes, and installs a new EFI_PEI_FIRMWARE_VOLUME_INFO(2)_PPI using\r
  the parameters passed in to initialize the fields of the EFI_PEI_FIRMWARE_VOLUME_INFO(2)_PPI instance.\r
  If the resources can not be allocated for EFI_PEI_FIRMWARE_VOLUME_INFO(2)_PPI, then ASSERT().\r
  If the EFI_PEI_FIRMWARE_VOLUME_INFO(2)_PPI can not be installed, then ASSERT().\r
  If NULL is specified for FvFormat, but FvInfo does not have the firmware file system 2 format, then ASSERT.\r
\r
  @param  InstallFvInfoPpi     Install FvInfo Ppi if it is TRUE. Otherwise, install FvInfo2 Ppi.\r
  @param  FvFormat             Unique identifier of the format of the memory-mapped\r
                               firmware volume.  This parameter is optional and\r
                               may be NULL.  If NULL is specified, the\r
                               EFI_FIRMWARE_FILE_SYSTEM2_GUID format is assumed.\r
  @param  FvInfo               Points to a buffer which allows the\r
                               EFI_PEI_FIRMWARE_VOLUME_PPI to process the volume.\r
                               The format of this buffer is specific to the FvFormat.\r
                               For memory-mapped firmware volumes, this typically\r
                               points to the first byte of the firmware volume.\r
  @param  FvInfoSize           The size, in bytes, of FvInfo. For memory-mapped\r
                               firmware volumes, this is typically the size of\r
                               the firmware volume.\r
  @param  ParentFvName         If the new firmware volume originated from a file\r
                               in a different firmware volume, then this parameter\r
                               specifies the GUID name of the originating firmware\r
                               volume. Otherwise, this parameter must be NULL.\r
  @param  ParentFileName       If the new firmware volume originated from a file\r
                               in a different firmware volume, then this parameter\r
                               specifies the GUID file name of the originating\r
                               firmware file. Otherwise, this parameter must be NULL.\r
  @param  AuthenticationStatus Authentication Status, it will be ignored if InstallFvInfoPpi is TRUE.\r
**/\r
VOID\r
EFIAPI\r
InternalPeiServicesInstallFvInfoPpi (\r
  IN       BOOLEAN   InstallFvInfoPpi,\r
  IN CONST EFI_GUID  *FvFormat  OPTIONAL,\r
  IN CONST VOID      *FvInfo,\r
  IN       UINT32    FvInfoSize,\r
  IN CONST EFI_GUID  *ParentFvName  OPTIONAL,\r
  IN CONST EFI_GUID  *ParentFileName  OPTIONAL,\r
  IN       UINT32    AuthenticationStatus\r
  )\r
{\r
  EFI_STATUS                        Status;\r
  EFI_PEI_FIRMWARE_VOLUME_INFO_PPI  *FvInfoPpi;\r
  EFI_PEI_PPI_DESCRIPTOR            *FvInfoPpiDescriptor;\r
  EFI_GUID                          *ParentFvNameValue;\r
  EFI_GUID                          *ParentFileNameValue;\r
  EFI_GUID                          *PpiGuid;\r
\r
  ParentFvNameValue   = NULL;\r
  ParentFileNameValue = NULL;\r
  if (InstallFvInfoPpi) {\r
    //\r
    // To install FvInfo Ppi.\r
    //\r
    FvInfoPpi = AllocateZeroPool (sizeof (EFI_PEI_FIRMWARE_VOLUME_INFO_PPI));\r
    ASSERT (FvInfoPpi != NULL);\r
    PpiGuid = &gEfiPeiFirmwareVolumeInfoPpiGuid;\r
  } else {\r
    //\r
    // To install FvInfo2 Ppi.\r
    //\r
    FvInfoPpi = AllocateZeroPool (sizeof (EFI_PEI_FIRMWARE_VOLUME_INFO2_PPI));\r
    ASSERT (FvInfoPpi != NULL);\r
    ((EFI_PEI_FIRMWARE_VOLUME_INFO2_PPI *)FvInfoPpi)->AuthenticationStatus = AuthenticationStatus;\r
    PpiGuid                                                                = &gEfiPeiFirmwareVolumeInfo2PpiGuid;\r
  }\r
\r
  if (FvFormat != NULL) {\r
    CopyGuid (&FvInfoPpi->FvFormat, FvFormat);\r
  } else {\r
    CopyGuid (&FvInfoPpi->FvFormat, &gEfiFirmwareFileSystem2Guid);\r
    //\r
    // Since the EFI_FIRMWARE_FILE_SYSTEM2_GUID format is assumed if NULL is specified for FvFormat,\r
    // check the FileSystemGuid pointed by FvInfo against EFI_FIRMWARE_FILE_SYSTEM2_GUID to make sure\r
    // FvInfo has the firmware file system 2 format.\r
    // If the ASSERT really appears, FvFormat needs to be specified correctly, for example,\r
    // EFI_FIRMWARE_FILE_SYSTEM3_GUID can be used for firmware file system 3 format, or\r
    // ((EFI_FIRMWARE_VOLUME_HEADER *) FvInfo)->FileSystemGuid can be just used for both\r
    // firmware file system 2 and 3 format.\r
    //\r
    ASSERT (CompareGuid (&(((EFI_FIRMWARE_VOLUME_HEADER *)FvInfo)->FileSystemGuid), &gEfiFirmwareFileSystem2Guid));\r
  }\r
\r
  FvInfoPpi->FvInfo     = (VOID *)FvInfo;\r
  FvInfoPpi->FvInfoSize = FvInfoSize;\r
  if (ParentFvName != NULL) {\r
    ParentFvNameValue = AllocateCopyPool (sizeof (EFI_GUID), ParentFvName);\r
    ASSERT (ParentFvNameValue != NULL);\r
    FvInfoPpi->ParentFvName = ParentFvNameValue;\r
  }\r
\r
  if (ParentFileName != NULL) {\r
    ParentFileNameValue = AllocateCopyPool (sizeof (EFI_GUID), ParentFileName);\r
    ASSERT (ParentFileNameValue != NULL);\r
    FvInfoPpi->ParentFileName = ParentFileNameValue;\r
  }\r
\r
  FvInfoPpiDescriptor = AllocatePool (sizeof (EFI_PEI_PPI_DESCRIPTOR));\r
  ASSERT (FvInfoPpiDescriptor != NULL);\r
\r
  FvInfoPpiDescriptor->Guid  = PpiGuid;\r
  FvInfoPpiDescriptor->Flags = EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST;\r
  FvInfoPpiDescriptor->Ppi   = (VOID *)FvInfoPpi;\r
  Status                     = PeiServicesInstallPpi (FvInfoPpiDescriptor);\r
  ASSERT_EFI_ERROR (Status);\r
}\r
\r
/**\r
  Install a EFI_PEI_FIRMWARE_VOLUME_INFO_PPI instance so the PEI Core will be notified about a new firmware volume.\r
\r
  This function allocates, initializes, and installs a new EFI_PEI_FIRMWARE_VOLUME_INFO_PPI using\r
  the parameters passed in to initialize the fields of the EFI_PEI_FIRMWARE_VOLUME_INFO_PPI instance.\r
  If the resources can not be allocated for EFI_PEI_FIRMWARE_VOLUME_INFO_PPI, then ASSERT().\r
  If the EFI_PEI_FIRMWARE_VOLUME_INFO_PPI can not be installed, then ASSERT().\r
  If NULL is specified for FvFormat, but FvInfo does not have the firmware file system 2 format, then ASSERT.\r
\r
  @param  FvFormat             Unique identifier of the format of the memory-mapped\r
                               firmware volume.  This parameter is optional and\r
                               may be NULL.  If NULL is specified, the\r
                               EFI_FIRMWARE_FILE_SYSTEM2_GUID format is assumed.\r
  @param  FvInfo               Points to a buffer which allows the\r
                               EFI_PEI_FIRMWARE_VOLUME_PPI to process the volume.\r
                               The format of this buffer is specific to the FvFormat.\r
                               For memory-mapped firmware volumes, this typically\r
                               points to the first byte of the firmware volume.\r
  @param  FvInfoSize           The size, in bytes, of FvInfo. For memory-mapped\r
                               firmware volumes, this is typically the size of\r
                               the firmware volume.\r
  @param  ParentFvName         If the new firmware volume originated from a file\r
                               in a different firmware volume, then this parameter\r
                               specifies the GUID name of the originating firmware\r
                               volume. Otherwise, this parameter must be NULL.\r
  @param  ParentFileName       If the new firmware volume originated from a file\r
                               in a different firmware volume, then this parameter\r
                               specifies the GUID file name of the originating\r
                               firmware file. Otherwise, this parameter must be NULL.\r
**/\r
VOID\r
EFIAPI\r
PeiServicesInstallFvInfoPpi (\r
  IN CONST EFI_GUID  *FvFormat  OPTIONAL,\r
  IN CONST VOID      *FvInfo,\r
  IN       UINT32    FvInfoSize,\r
  IN CONST EFI_GUID  *ParentFvName  OPTIONAL,\r
  IN CONST EFI_GUID  *ParentFileName OPTIONAL\r
  )\r
{\r
  InternalPeiServicesInstallFvInfoPpi (TRUE, FvFormat, FvInfo, FvInfoSize, ParentFvName, ParentFileName, 0);\r
}\r
\r
/**\r
  Install a EFI_PEI_FIRMWARE_VOLUME_INFO2_PPI instance so the PEI Core will be notified about a new firmware volume.\r
\r
  This function allocates, initializes, and installs a new EFI_PEI_FIRMWARE_VOLUME_INFO2_PPI using\r
  the parameters passed in to initialize the fields of the EFI_PEI_FIRMWARE_VOLUME_INFO2_PPI instance.\r
  If the resources can not be allocated for EFI_PEI_FIRMWARE_VOLUME_INFO2_PPI, then ASSERT().\r
  If the EFI_PEI_FIRMWARE_VOLUME_INFO2_PPI can not be installed, then ASSERT().\r
  If NULL is specified for FvFormat, but FvInfo does not have the firmware file system 2 format, then ASSERT.\r
\r
  @param  FvFormat             Unique identifier of the format of the memory-mapped\r
                               firmware volume.  This parameter is optional and\r
                               may be NULL.  If NULL is specified, the\r
                               EFI_FIRMWARE_FILE_SYSTEM2_GUID format is assumed.\r
  @param  FvInfo               Points to a buffer which allows the\r
                               EFI_PEI_FIRMWARE_VOLUME_PPI to process the volume.\r
                               The format of this buffer is specific to the FvFormat.\r
                               For memory-mapped firmware volumes, this typically\r
                               points to the first byte of the firmware volume.\r
  @param  FvInfoSize           The size, in bytes, of FvInfo. For memory-mapped\r
                               firmware volumes, this is typically the size of\r
                               the firmware volume.\r
  @param  ParentFvName         If the new firmware volume originated from a file\r
                               in a different firmware volume, then this parameter\r
                               specifies the GUID name of the originating firmware\r
                               volume. Otherwise, this parameter must be NULL.\r
  @param  ParentFileName       If the new firmware volume originated from a file\r
                               in a different firmware volume, then this parameter\r
                               specifies the GUID file name of the originating\r
                               firmware file. Otherwise, this parameter must be NULL.\r
  @param  AuthenticationStatus Authentication Status\r
**/\r
VOID\r
EFIAPI\r
PeiServicesInstallFvInfo2Ppi (\r
  IN CONST EFI_GUID  *FvFormat  OPTIONAL,\r
  IN CONST VOID      *FvInfo,\r
  IN       UINT32    FvInfoSize,\r
  IN CONST EFI_GUID  *ParentFvName  OPTIONAL,\r
  IN CONST EFI_GUID  *ParentFileName  OPTIONAL,\r
  IN       UINT32    AuthenticationStatus\r
  )\r
{\r
  InternalPeiServicesInstallFvInfoPpi (FALSE, FvFormat, FvInfo, FvInfoSize, ParentFvName, ParentFileName, AuthenticationStatus);\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.\r
\r
**/\r
VOID\r
EFIAPI\r
PeiServicesResetSystem2 (\r
  IN EFI_RESET_TYPE  ResetType,\r
  IN EFI_STATUS      ResetStatus,\r
  IN UINTN           DataSize,\r
  IN VOID            *ResetData OPTIONAL\r
  )\r
{\r
  (*GetPeiServicesTablePointer ())->ResetSystem2 (ResetType, ResetStatus, DataSize, ResetData);\r
}\r