MdePkg: fix comment typo in DebugLib.h

[mirror_edk2.git] / MdePkg / Include / Library / PeiServicesLib.h

/** @file\r
  Provides library functions for all PEI Services.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>\r
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_SERVICES_LIB_H__\r
#define __PEI_SERVICES_LIB_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
/**\r
  This service enables PEIMs to replace an entry in the PPI database with an alternate entry.\r
\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           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
/**\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,\r
  IN OUT VOID                   **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 that the caller\r
                                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 not have the\r
                                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
EFI_STATUS\r
EFIAPI\r
PeiServicesNotifyPpi (\r
  IN CONST EFI_PEI_NOTIFY_DESCRIPTOR  *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
/**\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
/**\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 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
/**\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 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
/**\r
  This service enables PEIMs to discover additional firmware volumes.\r
\r
  @param  Instance              This instance of the firmware volume to find.  The value 0 is the\r
                                Boot Firmware Volume (BFV).\r
  @param  VolumeHandle          Handle of the firmware volume header of the volume 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
/**\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          Pointer to the firmware volume header of the volume to search.\r
                                This parameter must point to a 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
/**\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 of sections to\r
                                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
/**\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
/**\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
/**\r
  This service enables PEIMs to allocate memory after the permanent memory has been installed by a\r
  PEIM.\r
\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 memory range was successfully allocated.\r
  @retval EFI_INVALID_PARAMETER Type is not equal to AllocateAnyPages.\r
  @retval EFI_NOT_AVAILABLE_YET Called with permanent memory not available.\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
/**\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 the allocate\r
                                buffer; undefined otherwise.\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
/**\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
\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     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
\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   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   If 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
/**\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   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   If 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
/**\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
\r
/**\r
  This service is a wrapper for the PEI Service RegisterForShadow(), 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   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
/**\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
\r
  \r
  @param  FvFormat             Unique identifier of the format of the memory-mapped firmware volume.\r
                               This parameter is optional and may be NULL.  \r
                               If NULL is specified, the EFI_FIRMWARE_FILE_SYSTEM2_GUID format is assumed.\r
  @param  FvInfo               Points to a buffer which allows the EFI_PEI_FIRMWARE_VOLUME_PPI to process the volume. \r
                               The format of this buffer is specific to the FvFormat. For memory-mapped firmware volumes, \r
                               this typically points to the first byte of the firmware volume.\r
  @param  FvInfoSize           The size, in bytes, of FvInfo. For memory-mapped firmware volumes, \r
                               this is typically the size of the firmware volume.\r
  @param  ParentFvName         If the new firmware volume originated from a file in a different firmware volume, \r
                               then this parameter specifies the GUID name of the originating firmware volume.\r
                               Otherwise, this parameter must be NULL.\r
  @param  ParentFileName       If the new firmware volume originated from a file in a different firmware volume, \r
                               then this parameter specifies the GUID file name of the originating firmware file.\r
                               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
/**\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
\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
#endif\r