Initial import.

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

/** @file\r
	PEI Core Library implementation\r
\r
	Copyright (c) 2006, 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
	Module Name:	PeiCoreLib.h\r
\r
**/\r
\r
#ifndef __PEI_CORE_LIB_H__\r
#define __PEI_CORE_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\r
	the EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field.\r
	@retval	EFI_OUT_OF_RESOURCES There is no additional space in the PPI database.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiCoreInstallPpi (\r
  IN EFI_PEI_PPI_DESCRIPTOR           *PpiList\r
  )\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\r
	the EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field.\r
	@retval	EFI_OUT_OF_RESOURCES There is no additional space in the PPI database.\r
	@retval	EFI_NOT_FOUND The PPI for which the reinstallation was requested has not been installed.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiCoreReinstallPpi (\r
  IN EFI_PEI_PPI_DESCRIPTOR           *OldPpi,\r
  IN EFI_PEI_PPI_DESCRIPTOR           *NewPpi\r
  )\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 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
PeiCoreLocatePpi (\r
  IN 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
	This service enables PEIMs to register a given service to be invoked\r
	when another service is installed or reinstalled.\r
\r
	@param	NotifyList A pointer to the list of notification interfaces that the caller shall install.\r
\r
	@retval	EFI_SUCCESS The interface was successfully installed.\r
	@retval	EFI_INVALID_PARAMETER The NotifyList pointer is NULL.\r
	@retval	EFI_INVALID_PARAMETER Any of the PEI notify descriptors in the list do not have\r
	the EFI_PEI_PPI_DESCRIPTOR_NOTIFY_TYPES bit set in the Flags field.\r
	@retval	EFI_OUT_OF_RESOURCES There is no additional space in the PPI database.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiCoreNotifyPpi (\r
  IN EFI_PEI_NOTIFY_DESCRIPTOR        *NotifyList\r
  )\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
PeiCoreGetBootMode (\r
  IN OUT EFI_BOOT_MODE                *BootMode\r
  )\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
PeiCoreSetBootMode (\r
  IN EFI_BOOT_MODE                    BootMode\r
  )\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
PeiCoreGetHobList (\r
  IN OUT VOID                         **HobList\r
  )\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
PeiCoreCreateHob (\r
  IN UINT16                           Type,\r
  IN UINT16                           Length,\r
  IN OUT VOID                         **Hob\r
  )\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.\r
	The value 0 is the Boot Firmware Volume (BFV).\r
	@param	FwVolHeader Pointer to 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
PeiCoreFfsFindNextVolume (\r
  IN UINTN                            Instance,\r
  IN OUT EFI_FIRMWARE_VOLUME_HEADER   **FwVolHeader\r
  )\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	FwVolHeader Pointer to the firmware volume header of the volume to search.\r
	This parameter must point to a valid FFS volume.\r
	@param	FileHeader Pointer to 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
PeiCoreFfsFindNextFile (\r
  IN EFI_FV_FILETYPE                  SearchType,\r
  IN EFI_FIRMWARE_VOLUME_HEADER       *FwVolHeader,\r
  IN OUT EFI_FFS_FILE_HEADER          **FileHeader\r
  )\r
;\r
\r
/**\r
	This service enables PEIMs to discover sections of a given type within a valid FFS file.\r
\r
	@param	SearchType The value of the section type to find.\r
	@param	FfsFileHeader A pointer to the file header that contains the set 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
PeiCoreFfsFindSectionData (\r
  IN EFI_SECTION_TYPE                 SectionType,\r
  IN EFI_FFS_FILE_HEADER              *FfsFileHeader,\r
  IN OUT VOID                         **SectionData\r
  )\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
PeiCoreInstallPeiMemory (\r
  IN EFI_PHYSICAL_ADDRESS             MemoryBegin,\r
  IN UINT64                           MemoryLength\r
  )\r
;\r
\r
/**\r
	This service enables PEIMs to allocate memory after the permanent memory has been installed by a 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
PeiCoreAllocatePages (\r
  IN EFI_MEMORY_TYPE                  MemoryType,\r
  IN UINTN                            Pages,\r
  IN OUT EFI_PHYSICAL_ADDRESS         *Memory\r
  )\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 allocated buffer;\r
	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
PeiCoreAllocatePool (\r
  IN UINTN                            Size,\r
  OUT VOID                            **Buffer\r
  )\r
;\r
\r
/**\r
	This service resets the entire platform, including all processors and devices, and reboots the system. \r
\r
	@retval	EFI_NOT_AVAILABLE_YET The service has not been installed yet.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiCoreResetSystem (\r
  VOID\r
  )\r
;\r
\r
#endif\r