/** @file\r
PI PEI master include file. This file should match the PI spec.\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
+Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+The full text of the license may be found at\r
+http://opensource.org/licenses/bsd-license.php. \r
+ \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
+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
@par Revision Reference:\r
- Version 1.0.\r
+ PI Version 1.2.\r
\r
**/\r
\r
#ifndef __PI_PEICIS_H__\r
#define __PI_PEICIS_H__\r
\r
+#include <Uefi/UefiMultiPhase.h>\r
#include <Pi/PiMultiPhase.h>\r
\r
///\r
-/// Handles of EFI FV.\r
+/// The handles of EFI FV.\r
/// \r
typedef VOID *EFI_PEI_FV_HANDLE;\r
\r
///\r
-/// Handles of EFI FFS\r
+/// The handles of EFI FFS.\r
/// \r
typedef VOID *EFI_PEI_FILE_HANDLE;\r
\r
///\r
-/// Declare forward reference data structure for EFI_PEI_SERVICE\r
+/// Declare the forward reference data structure for EFI_PEI_SERVICE.\r
/// \r
typedef struct _EFI_PEI_SERVICES EFI_PEI_SERVICES;\r
\r
///\r
-/// Declare forward reference data structure for EFI_PEI_NOTIFY_DESCRIPTOR\r
+/// Declare the forward reference data structure for EFI_PEI_NOTIFY_DESCRIPTOR.\r
/// \r
typedef struct _EFI_PEI_NOTIFY_DESCRIPTOR EFI_PEI_NOTIFY_DESCRIPTOR;\r
\r
/// The data structure through which a PEIM describes available services to the PEI Foundation.\r
/// \r
typedef struct {\r
+ ///\r
+ /// This field is a set of flags describing the characteristics of this imported table entry.\r
+ /// All flags are defined as EFI_PEI_PPI_DESCRIPTOR_***, which can also be combined into one.\r
+ ///\r
UINTN Flags;\r
+ ///\r
+ /// The address of the EFI_GUID that names the interface.\r
+ ///\r
EFI_GUID *Guid;\r
+ ///\r
+ /// A pointer to the PPI. It contains the information necessary to install a service.\r
+ ///\r
VOID *Ppi;\r
} EFI_PEI_PPI_DESCRIPTOR;\r
\r
/// Foundation where to invoke the notification service.\r
/// \r
struct _EFI_PEI_NOTIFY_DESCRIPTOR {\r
+ ///\r
+ /// Details if the type of notification are callback or dispatch.\r
+ ///\r
UINTN Flags;\r
+ ///\r
+ /// The address of the EFI_GUID that names the interface.\r
+ ///\r
EFI_GUID *Guid;\r
+ ///\r
+ /// Address of the notification callback function itself within the PEIM.\r
+ ///\r
EFI_PEIM_NOTIFY_ENTRY_POINT Notify;\r
};\r
\r
///\r
-/// Describes request of the module to be loaded to \r
-/// the permanent memory once it is available. Unlike most of the other HOBs, \r
-/// this HOB is produced and consumed during the HOB producer phase.\r
-/// \r
-typedef struct _EFI_HOB_LOAD_PEIM {\r
- EFI_HOB_GENERIC_HEADER Header;\r
- EFI_PEI_FILE_HANDLE FileHandle;\r
- EFI_PEIM_ENTRY_POINT2 EntryPoint;\r
- EFI_PEIM_ENTRY_POINT2 InMemEntryPoint;\r
-} EFI_HOB_LOAD_PEIM;\r
-\r
+/// This data structure is the means by which callable services are installed and\r
+/// notifications are registered in the PEI phase.\r
+///\r
+typedef union {\r
+ ///\r
+ /// The typedef structure of the notification descriptor.\r
+ ///\r
+ EFI_PEI_NOTIFY_DESCRIPTOR Notify;\r
+ ///\r
+ /// The typedef structure of the PPI descriptor.\r
+ ///\r
+ EFI_PEI_PPI_DESCRIPTOR Ppi;\r
+} EFI_PEI_DESCRIPTOR;\r
\r
/**\r
This service is the first one provided by the PEI Foundation. This function \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 or Any of the PEI PPI descriptors in the list do not have the EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field.\r
+ @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL or Any of the PEI PPI \r
+ 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
@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 PpiList pointer is NULL or Any of the PEI PPI descriptors in the \r
+ @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL, or any of the PEI PPI descriptors in the \r
list do not have 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
@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_SUCCESS The boot mode returned successfully.\r
\r
**/\r
typedef\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
- @retval EFI_SUCCESS The boot mode was returned successfully.\r
+ @retval EFI_SUCCESS The boot mode returned successfully.\r
\r
**/\r
typedef\r
);\r
\r
/**\r
- This service published by the PEI Foundation abstracts the creation of a Hand-Off Block's (HOB's) headers.\r
+ This service, published by the PEI Foundation, abstracts the creation of a Hand-Off Block's (HOB's) headers.\r
\r
@param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
@param Type The type of HOB to be installed.\r
This service will search within encapsulation sections (compression and GUIDed) as well. It will\r
search inside of a GUIDed section or a compressed section, but may not, for example, search a\r
GUIDed section inside a GUIDes section.\r
- This service will not search within compression sections or GUIDed sections which require\r
+ This service will not search within compression sections or GUIDed sections that require\r
extraction if memory is not present.\r
\r
@param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
This function registers the found memory configuration with the PEI Foundation.\r
\r
@param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
- @param MemoryBegin The value of a region of installed memory\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
@param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
@param MemoryType The type of memory to allocate.\r
@param Pages The number of contiguous 4 KB pages to allocate.\r
- @param Memory Pointer to a physical address. On output, the address is set to the base \r
+ @param Memory A pointer to a physical address. On output, the address is set to the base \r
of the page range that was allocated.\r
\r
@retval EFI_SUCCESS The memory range was successfully allocated.\r
@retval EFI_OUT_OF_RESOURCES The pages could not be allocated.\r
- @retval EFI_INVALID_PARAMETER Type is not equal to AllocateAnyPages.\r
+ @retval EFI_INVALID_PARAMETER The type is not equal to EfiLoaderCode, EfiLoaderData, EfiRuntimeServicesCode, \r
+ EfiRuntimeServicesData, EfiBootServicesCode, EfiBootServicesData,\r
+ EfiACPIReclaimMemory, or EfiACPIMemoryNVS.\r
\r
**/\r
typedef\r
/**\r
This service copies the contents of one buffer to another buffer.\r
\r
- @param Destination Pointer to the destination buffer of the memory copy.\r
- @param Source Pointer to the source buffer of the memory copy\r
- @param Length Number of bytes to copy from Source to Destination.\r
+ @param Destination The pointer to the destination buffer of the memory copy.\r
+ @param Source The pointer to the source buffer of the memory copy.\r
+ @param Length The number of bytes to copy from Source to Destination.\r
\r
**/\r
typedef\r
/**\r
The service fills a buffer with a specified value.\r
\r
- @param Buffer Pointer to the buffer to fill.\r
- @param Size Number of bytes in Buffer to fill.\r
- @param Value Value to fill Buffer with\r
+ @param Buffer The pointer to the buffer to fill.\r
+ @param Size The number of bytes in Buffer to fill.\r
+ @param Value The value to fill Buffer with.\r
\r
**/\r
typedef\r
@param FileHandle Upon exit, points to the found file's\r
handle or NULL if it could not be found.\r
\r
- @retval EFI_SUCCESS File was found.\r
- @retval EFI_NOT_FOUND File was not found.\r
+ @retval EFI_SUCCESS The file was found.\r
+ @retval EFI_NOT_FOUND The file was not found.\r
@retval EFI_INVALID_PARAMETER VolumeHandle or FileHandle or\r
FileName was NULL.\r
\r
);\r
\r
///\r
-/// Information of FV file.\r
+/// The information of the FV file.\r
///\r
typedef struct {\r
///\r
///\r
VOID *Buffer;\r
///\r
- /// Size of the file\92s data.\r
+ /// Size of the file's data.\r
///\r
UINT32 BufferSize;\r
} EFI_FV_FILE_INFO;\r
\r
This function returns information about a specific file,\r
including its file name, type, attributes, starting address and\r
- size. If the firmware volume is not memory mapped then the\r
+ size. If the firmware volume is not memory mapped, then the\r
Buffer member will be NULL.\r
\r
- @param FileHandle Handle of the file.\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
+ @retval EFI_SUCCESS File information was returned.\r
+ @retval EFI_INVALID_PARAMETER FileHandle does not\r
represent a valid file.\r
- @retval EFI_INVALID_PARAMETER If FileInfo is NULL.\r
+ @retval EFI_INVALID_PARAMETER FileInfo is NULL.\r
\r
**/\r
typedef\r
);\r
\r
///\r
-/// Information of FV volume.\r
+/// The information of the FV volume.\r
///\r
typedef struct {\r
///\r
and size.\r
\r
@param VolumeHandle Handle of the volume.\r
+ @param VolumeInfo Upon exit, points to the volume's information.\r
\r
- @param VolumeInfo Upon exit, points to the volume'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 If FileInfo is NULL.\r
+ @retval EFI_SUCCESS The volume information returned.\r
+ @retval EFI_INVALID_PARAMETER If VolumeHandle does not represent a valid volume.\r
+ @retval EFI_INVALID_PARAMETER If VolumeHandle is NULL.\r
+ @retval EFI_SUCCESS Information was successfully returned.\r
+ @retval EFI_INVALID_PARAMETER The volume designated by the VolumeHandle is not available.\r
\r
**/\r
typedef\r
// PEI Specification Revision information\r
//\r
#define PEI_SPECIFICATION_MAJOR_REVISION 1\r
-#define PEI_SPECIFICATION_MINOR_REVISION 0\r
-\r
+#define PEI_SPECIFICATION_MINOR_REVISION 20\r
+///\r
+/// Specification inconsistency here: \r
+/// In the PI1.0 spec, PEI_SERVICES_SIGNATURE is defined as 0x5652455320494550. But \r
+/// to pass a multiple tool chain, it appends an ULL.\r
+///\r
//\r
// PEI Services Table\r
//\r
#define PEI_SERVICES_SIGNATURE 0x5652455320494550ULL\r
+///\r
+/// Specification inconsistency here: \r
+/// In the PI1.0 specification, there is a typo error in PEI_SERVICES_REVISION. In the specification the defintion is \r
+/// #define ((PEI_SPECIFICATION_MAJOR_REVISION<<16) |(PEI_SPECIFICATION_MINOR_REVISION))\r
+/// and it should be as follows:\r
+///\r
#define PEI_SERVICES_REVISION ((PEI_SPECIFICATION_MAJOR_REVISION<<16) | (PEI_SPECIFICATION_MINOR_REVISION))\r
\r
/// \r
/// - Allocating both early and permanent memory\r
/// - Supporting the Firmware File System (FFS)\r
/// - Abstracting the PPI database abstraction\r
-/// - Creating Hand-Off Blocks (HOBs)\r
+/// - Creating Hand-Off Blocks (HOBs).\r
///\r
struct _EFI_PEI_SERVICES {\r
///\r
/// The table header for the PEI Services Table.\r
///\r
- EFI_TABLE_HEADER Hdr;\r
- ///\r
- /// Installs an interface in the PEI PEIM-to-PEIM\r
- /// Interface (PPI) database by GUID.\r
- ///\r
- EFI_PEI_INSTALL_PPI InstallPpi;\r
- ///\r
- /// Reinstalls an interface in the PEI PPI database by GUID.\r
- ///\r
- EFI_PEI_REINSTALL_PPI ReInstallPpi;\r
- ///\r
- /// Locates an interface in the PEI PPI database by GUID.\r
- ///\r
- EFI_PEI_LOCATE_PPI LocatePpi;\r
- ///\r
- /// Installs the notification service to be called back\r
- /// upon the installation or reinstallation of a given interface.\r
- ///\r
- EFI_PEI_NOTIFY_PPI NotifyPpi;\r
- ///\r
- /// Returns the present value of the boot mode.\r
- ///\r
- EFI_PEI_GET_BOOT_MODE GetBootMode;\r
- ///\r
- /// Sets the value of the boot mode.\r
- ///\r
- EFI_PEI_SET_BOOT_MODE SetBootMode;\r
- ///\r
- /// Returns the pointer to the list of Hand-Off Blocks (HOBs) in memory.\r
- ///\r
- EFI_PEI_GET_HOB_LIST GetHobList;\r
- ///\r
- /// Abstracts the creation of HOB headers.\r
- ///\r
- EFI_PEI_CREATE_HOB CreateHob;\r
- ///\r
- /// Discovers instances of firmware volumes in the system.\r
- ///\r
+ EFI_TABLE_HEADER Hdr;\r
+\r
+ //\r
+ // PPI Functions\r
+ //\r
+ EFI_PEI_INSTALL_PPI InstallPpi;\r
+ EFI_PEI_REINSTALL_PPI ReInstallPpi;\r
+ EFI_PEI_LOCATE_PPI LocatePpi;\r
+ EFI_PEI_NOTIFY_PPI NotifyPpi;\r
+\r
+ //\r
+ // Boot Mode Functions\r
+ //\r
+ EFI_PEI_GET_BOOT_MODE GetBootMode;\r
+ EFI_PEI_SET_BOOT_MODE SetBootMode;\r
+\r
+ //\r
+ // HOB Functions\r
+ //\r
+ EFI_PEI_GET_HOB_LIST GetHobList;\r
+ EFI_PEI_CREATE_HOB CreateHob;\r
+\r
+ //\r
+ // Firmware Volume Functions\r
+ //\r
EFI_PEI_FFS_FIND_NEXT_VOLUME2 FfsFindNextVolume;\r
- ///\r
- /// Discovers instances of firmware files in the system.\r
- ///\r
EFI_PEI_FFS_FIND_NEXT_FILE2 FfsFindNextFile;\r
- ///\r
- /// Searches for a section in a firmware file.\r
- ///\r
EFI_PEI_FFS_FIND_SECTION_DATA2 FfsFindSectionData;\r
- ///\r
- /// Registers the found memory configuration with the PEI Foundation.\r
- ///\r
- EFI_PEI_INSTALL_PEI_MEMORY InstallPeiMemory;\r
- ///\r
- /// Allocates memory ranges that are managed by the PEI Foundation.\r
- ///\r
- EFI_PEI_ALLOCATE_PAGES AllocatePages;\r
- ///\r
- /// Allocate memory ranges that are managed by the PEI Foundation.\r
- ///\r
- EFI_PEI_ALLOCATE_POOL AllocatePool;\r
- ///\r
- /// Copies the contents of one buffer to another buffer.\r
- ///\r
- EFI_PEI_COPY_MEM CopyMem;\r
- ///\r
- /// Fills a buffer with a specified value.\r
- ///\r
- EFI_PEI_SET_MEM SetMem;\r
- ///\r
- /// Provides an interface that a PEIM can call to report a status code.\r
- ///\r
- EFI_PEI_REPORT_STATUS_CODE ReportStatusCode;\r
- ///\r
- /// Resets the entire platform.\r
- ///\r
- EFI_PEI_RESET_SYSTEM ResetSystem;\r
- ///\r
- /// Provides an interface that a PEIM can call to execute\r
- /// an I/O transaction. This interface is installed by provider\r
- /// PEIM by copying the interface into the PEI Service table.\r
- ///\r
- EFI_PEI_CPU_IO_PPI *CpuIo;\r
- ///\r
- /// Provides an interface that a PEIM can call to execute PCI\r
- /// Configuration transactions. This interface is installed by\r
- /// provider PEIM by copying the interface into the EFI_PEI_SERVICES table.\r
- ///\r
- EFI_PEI_PCI_CFG2_PPI *PciCfg;\r
- ///\r
- /// Discovers firmware files within a volume by name.\r
- ///\r
- EFI_PEI_FFS_FIND_BY_NAME FfsFindFileByName;\r
- ///\r
- /// Return information about a particular file.\r
- ///\r
- EFI_PEI_FFS_GET_FILE_INFO FfsGetFileInfo;\r
- ///\r
- /// Return information about a particular volume.\r
- ///\r
- EFI_PEI_FFS_GET_VOLUME_INFO FfsGetVolumeInfo;\r
- ///\r
- /// Register a driver to be re-loaded when memory is available.\r
- ///\r
- EFI_PEI_REGISTER_FOR_SHADOW RegisterForShadow;\r
+\r
+ //\r
+ // PEI Memory Functions\r
+ //\r
+ EFI_PEI_INSTALL_PEI_MEMORY InstallPeiMemory;\r
+ EFI_PEI_ALLOCATE_PAGES AllocatePages;\r
+ EFI_PEI_ALLOCATE_POOL AllocatePool;\r
+ EFI_PEI_COPY_MEM CopyMem;\r
+ EFI_PEI_SET_MEM SetMem;\r
+\r
+ //\r
+ // Status Code\r
+ //\r
+ EFI_PEI_REPORT_STATUS_CODE ReportStatusCode;\r
+\r
+ //\r
+ // Reset\r
+ //\r
+ EFI_PEI_RESET_SYSTEM ResetSystem;\r
+\r
+ //\r
+ // (the following interfaces are installed by publishing PEIM)\r
+ // I/O Abstractions\r
+ //\r
+ EFI_PEI_CPU_IO_PPI *CpuIo;\r
+ EFI_PEI_PCI_CFG2_PPI *PciCfg;\r
+\r
+ //\r
+ // Future Installed Services\r
+ //\r
+ EFI_PEI_FFS_FIND_BY_NAME FfsFindFileByName;\r
+ EFI_PEI_FFS_GET_FILE_INFO FfsGetFileInfo;\r
+ EFI_PEI_FFS_GET_VOLUME_INFO FfsGetVolumeInfo;\r
+ EFI_PEI_REGISTER_FOR_SHADOW RegisterForShadow;\r
};\r
\r
\r
///\r
-/// EFI_SEC_PEI_HAND_OFF structure hold information about\r
+/// EFI_SEC_PEI_HAND_OFF structure holds information about\r
/// PEI core's operating environment, such as the size of location of\r
/// temporary RAM, the stack location and BFV location.\r
/// \r
VOID *PeiTemporaryRamBase;\r
\r
///\r
- /// Size of the available temporary RAM available for \r
+ /// The size of the available temporary RAM available for \r
/// use by the PEI Foundation, in bytes.\r
/// \r
UINTN PeiTemporaryRamSize;\r
\r
\r
/**\r
- Entry point of PEI Foundation.\r
+ The entry point of PEI Foundation.\r
\r
This function is the entry point for the PEI Foundation, which\r
allows the SEC phase to pass information about the stack,\r
projects / mirror_edk2.git / blobdiff