/** @file\r
PI PEI master include file. This file should match the PI spec.\r
\r
-Copyright (c) 2006 - 2016, 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
+Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>\r
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
@par Revision Reference:\r
- PI Version 1.4a.\r
+ PI Version 1.7.\r
\r
**/\r
\r
\r
///\r
/// The handles of EFI FV.\r
-/// \r
-typedef VOID *EFI_PEI_FV_HANDLE;\r
+///\r
+typedef VOID *EFI_PEI_FV_HANDLE;\r
\r
///\r
/// The handles of EFI FFS.\r
-/// \r
-typedef VOID *EFI_PEI_FILE_HANDLE;\r
+///\r
+typedef VOID *EFI_PEI_FILE_HANDLE;\r
\r
///\r
/// Declare the forward reference data structure for EFI_PEI_SERVICE.\r
-/// \r
-typedef struct _EFI_PEI_SERVICES EFI_PEI_SERVICES;\r
+///\r
+typedef struct _EFI_PEI_SERVICES EFI_PEI_SERVICES;\r
\r
///\r
/// Declare the forward reference data structure for EFI_PEI_NOTIFY_DESCRIPTOR.\r
-/// \r
+///\r
typedef struct _EFI_PEI_NOTIFY_DESCRIPTOR EFI_PEI_NOTIFY_DESCRIPTOR;\r
\r
-\r
#include <Ppi/CpuIo.h>\r
#include <Ppi/PciCfg2.h>\r
\r
-\r
/**\r
- The PEI Dispatcher will invoke each PEIM one time. During this pass, the PEI \r
- Dispatcher will pass control to the PEIM at the AddressOfEntryPoint in the PE Header. \r
+ The PEI Dispatcher will invoke each PEIM one time. During this pass, the PEI\r
+ Dispatcher will pass control to the PEIM at the AddressOfEntryPoint in the PE Header.\r
\r
@param FileHandle Pointer to the FFS file header.\r
@param PeiServices Describes the list of possible PEI Services.\r
\r
///\r
/// The data structure through which a PEIM describes available services to the PEI Foundation.\r
-/// \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
+ UINTN Flags;\r
///\r
/// The address of the EFI_GUID that names the interface.\r
///\r
- EFI_GUID *Guid;\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
+ VOID *Ppi;\r
} EFI_PEI_PPI_DESCRIPTOR;\r
\r
-/// \r
-/// The data structure in a given PEIM that tells the PEI \r
+///\r
+/// The data structure in a given PEIM that tells the PEI\r
/// Foundation where to invoke the notification service.\r
-/// \r
+///\r
struct _EFI_PEI_NOTIFY_DESCRIPTOR {\r
///\r
/// Details if the type of notification are callback or dispatch.\r
///\r
- UINTN Flags;\r
+ UINTN Flags;\r
///\r
/// The address of the EFI_GUID that names the interface.\r
///\r
- EFI_GUID *Guid;\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
+ EFI_PEIM_NOTIFY_ENTRY_POINT Notify;\r
};\r
\r
///\r
///\r
/// The typedef structure of the notification descriptor.\r
///\r
- EFI_PEI_NOTIFY_DESCRIPTOR Notify;\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_PPI_DESCRIPTOR Ppi;\r
} EFI_PEI_DESCRIPTOR;\r
\r
/**\r
- This service is the first one provided by the PEI Foundation. This function \r
- installs an interface in the PEI PPI database by GUID. The purpose of the \r
- service is to publish an interface that other parties can use to call \r
+ This service is the first one provided by the PEI Foundation. This function\r
+ installs an interface in the PEI PPI database by GUID. The purpose of the\r
+ service is to publish an interface that other parties can use to call\r
additional PEIMs.\r
\r
@param PeiServices An indirect pointer to the EFI_PEI_SERVICES table\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 \r
- descriptors in the list do not have the \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
\r
/**\r
- This function reinstalls an interface in the PEI PPI database by GUID. \r
- The purpose of the service is to publish an interface that other parties \r
- can use to replace a same-named interface in the protocol database \r
- with a different interface. \r
+ This function reinstalls an interface in the PEI PPI database by GUID.\r
+ The purpose of the service is to publish an interface that other parties\r
+ can use to replace a same-named interface in the protocol database\r
+ with a different interface.\r
\r
@param PeiServices An indirect pointer to the EFI_PEI_SERVICES table\r
published by the PEI Foundation.\r
@param NewPpi A pointer to the new 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
@retval EFI_NOT_FOUND The PPI for which the reinstallation was requested has not been installed.\r
);\r
\r
/**\r
- This function locates an interface in the PEI PPI database by GUID. \r
+ This function locates an interface in the PEI PPI database by GUID.\r
\r
@param PeiServices An indirect pointer to the EFI_PEI_SERVICES published by the PEI Foundation.\r
@param Guid A pointer to the GUID whose corresponding interface needs to be found.\r
);\r
\r
/**\r
- This function installs a notification service to be called back when a \r
- given interface is installed or reinstalled. The purpose of the service \r
- is to publish an interface that other parties can use to call additional PPIs \r
+ This function installs a notification service to be called back when a\r
+ given interface is installed or reinstalled. The purpose of the service\r
+ is to publish an interface that other parties can use to call additional PPIs\r
that may materialize later.\r
\r
@param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation\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
- 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 descriptors in the\r
+ list do not have 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
);\r
\r
/**\r
- This function returns the pointer to the list of Hand-Off Blocks (HOBs) in memory. \r
+ This function returns the pointer to the list of Hand-Off Blocks (HOBs) in memory.\r
\r
@param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation\r
@param HobList A pointer to the list of HOBs that the PEI Foundation will initialize\r
);\r
\r
/**\r
- The purpose of the service is to abstract the capability of the PEI \r
- Foundation to discover instances of firmware volumes in the system. \r
+ The purpose of the service is to abstract the capability of the PEI\r
+ Foundation to discover instances of firmware volumes in the system.\r
\r
This service enables PEIMs to discover additional firmware volumes. The PEI Foundation uses this\r
service to abstract the locations and formats of various firmware volumes. These volumes include\r
);\r
\r
/**\r
- The purpose of the service is to publish an interface that allows \r
+ The purpose of the service is to publish an interface that allows\r
PEIMs to allocate memory ranges that are managed by the PEI Foundation.\r
\r
+ Prior to InstallPeiMemory() being called, PEI will allocate pages from the heap.\r
+ After InstallPeiMemory() is called, PEI will allocate pages within the region\r
+ of memory provided by InstallPeiMemory() service in a best-effort fashion.\r
+ Location-specific allocations are not managed by the PEI foundation code.\r
+\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 A 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 The type is not equal to EfiLoaderCode, EfiLoaderData, EfiRuntimeServicesCode, \r
+ @retval EFI_INVALID_PARAMETER The type is not equal to EfiLoaderCode, EfiLoaderData, EfiRuntimeServicesCode,\r
EfiRuntimeServicesData, EfiBootServicesCode, EfiBootServicesData,\r
EfiACPIReclaimMemory, EfiReservedMemoryType, or EfiACPIMemoryNVS.\r
\r
);\r
\r
/**\r
- The purpose of this service is to publish an interface that \r
+ Frees memory pages.\r
+\r
+ @param[in] PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
+ @param[in] Memory The base physical address of the pages to be freed.\r
+ @param[in] Pages The number of contiguous 4 KB 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
+typedef\r
+EFI_STATUS\r
+(EFIAPI *EFI_PEI_FREE_PAGES)(\r
+ IN CONST EFI_PEI_SERVICES **PeiServices,\r
+ IN EFI_PHYSICAL_ADDRESS Memory,\r
+ IN UINTN Pages\r
+ );\r
+\r
+/**\r
+ The purpose of this service is to publish an interface that\r
allows PEIMs to allocate memory ranges that are managed by the PEI Foundation.\r
\r
@param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
\r
This service resets the entire platform, including all processors\r
and devices, and reboots the system.\r
- This service will never return EFI_SUCCESS. \r
+ This service will never return EFI_SUCCESS.\r
\r
@param PeiServices An indirect pointer to the EFI_PEI_SERVICES\r
table published by the PEI Foundation.\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 WatchdogData.\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. ResetData is only valid if ResetStatus is something\r
- other than EFI_SUCCESS unless the ResetType is EfiResetPlatformSpecific\r
- where a minimum amount of ResetData is always required.\r
+ system reset.\r
\r
**/\r
typedef\r
VOID\r
-(EFIAPI *EFI_PEI_RESET2_SYSTEM) (\r
+(EFIAPI *EFI_PEI_RESET2_SYSTEM)(\r
IN EFI_RESET_TYPE ResetType,\r
IN EFI_STATUS ResetStatus,\r
IN UINTN DataSize,\r
///\r
/// Name of the file.\r
///\r
- EFI_GUID FileName;\r
+ EFI_GUID FileName;\r
///\r
/// File type.\r
///\r
- EFI_FV_FILETYPE FileType;\r
+ EFI_FV_FILETYPE FileType;\r
///\r
/// Attributes of the file.\r
///\r
- EFI_FV_FILE_ATTRIBUTES FileAttributes;\r
+ EFI_FV_FILE_ATTRIBUTES FileAttributes;\r
///\r
/// Points to the file's data (not the header).\r
/// Not valid if EFI_FV_FILE_ATTRIB_MEMORY_MAPPED\r
/// is zero.\r
///\r
- VOID *Buffer;\r
+ VOID *Buffer;\r
///\r
/// Size of the file's data.\r
///\r
- UINT32 BufferSize;\r
+ UINT32 BufferSize;\r
} EFI_FV_FILE_INFO;\r
\r
///\r
///\r
/// Name of the file.\r
///\r
- EFI_GUID FileName;\r
+ EFI_GUID FileName;\r
///\r
/// File type.\r
///\r
- EFI_FV_FILETYPE FileType;\r
+ EFI_FV_FILETYPE FileType;\r
///\r
/// Attributes of the file.\r
///\r
- EFI_FV_FILE_ATTRIBUTES FileAttributes;\r
+ EFI_FV_FILE_ATTRIBUTES FileAttributes;\r
///\r
/// Points to the file's data (not the header).\r
/// Not valid if EFI_FV_FILE_ATTRIB_MEMORY_MAPPED\r
/// is zero.\r
///\r
- VOID *Buffer;\r
+ VOID *Buffer;\r
///\r
/// Size of the file's data.\r
///\r
- UINT32 BufferSize;\r
+ UINT32 BufferSize;\r
///\r
/// Authentication status for this file.\r
///\r
- UINT32 AuthenticationStatus;\r
+ UINT32 AuthenticationStatus;\r
} EFI_FV_FILE_INFO2;\r
\r
/**\r
@retval EFI_INVALID_PARAMETER FileHandle does not\r
represent a valid file.\r
@retval EFI_INVALID_PARAMETER FileInfo is NULL.\r
- \r
+\r
**/\r
typedef\r
EFI_STATUS\r
///\r
/// Attributes of the firmware volume.\r
///\r
- EFI_FVB_ATTRIBUTES_2 FvAttributes;\r
+ EFI_FVB_ATTRIBUTES_2 FvAttributes;\r
///\r
/// Format of the firmware volume.\r
///\r
- EFI_GUID FvFormat;\r
+ EFI_GUID FvFormat;\r
///\r
/// Name of the firmware volume.\r
///\r
- EFI_GUID FvName;\r
+ EFI_GUID FvName;\r
///\r
/// Points to the first byte of the firmware\r
/// volume, if bit EFI_FVB_MEMORY_MAPPED is\r
/// set in FvAttributes.\r
///\r
- VOID *FvStart;\r
+ VOID *FvStart;\r
///\r
/// Size of the firmware volume.\r
///\r
- UINT64 FvSize;\r
+ UINT64 FvSize;\r
} EFI_FV_INFO;\r
\r
/**\r
\r
@param FileHandle PEIM's file handle. Must be the currently\r
executing PEIM.\r
- \r
+\r
@retval EFI_SUCCESS The PEIM was successfully registered for\r
shadowing.\r
@retval EFI_ALREADY_STARTED The PEIM was previously\r
IN EFI_PEI_FILE_HANDLE FileHandle\r
);\r
\r
-\r
//\r
// PEI Specification Revision information\r
//\r
#define PEI_SPECIFICATION_MAJOR_REVISION 1\r
-#define PEI_SPECIFICATION_MINOR_REVISION 40\r
+#define PEI_SPECIFICATION_MINOR_REVISION 70\r
///\r
-/// Specification inconsistency here: \r
-/// In the PI1.0 spec, PEI_SERVICES_SIGNATURE is defined as 0x5652455320494550. But \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
//\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
+/// 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
+#define PEI_SERVICES_REVISION ((PEI_SPECIFICATION_MAJOR_REVISION<<16) | (PEI_SPECIFICATION_MINOR_REVISION))\r
\r
-/// \r
+///\r
/// EFI_PEI_SERVICES is a collection of functions whose implementation is provided by the PEI\r
/// Foundation. These services fall into various classes, including the following:\r
/// - Managing the boot mode\r
///\r
/// The table header for the PEI Services Table.\r
///\r
- EFI_TABLE_HEADER Hdr;\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
+ 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
+ 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
+ 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
- EFI_PEI_FFS_FIND_NEXT_FILE2 FfsFindNextFile;\r
- EFI_PEI_FFS_FIND_SECTION_DATA2 FfsFindSectionData;\r
+ EFI_PEI_FFS_FIND_NEXT_VOLUME2 FfsFindNextVolume;\r
+ EFI_PEI_FFS_FIND_NEXT_FILE2 FfsFindNextFile;\r
+ EFI_PEI_FFS_FIND_SECTION_DATA2 FfsFindSectionData;\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
+ 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
+ EFI_PEI_REPORT_STATUS_CODE ReportStatusCode;\r
\r
//\r
// Reset\r
//\r
- EFI_PEI_RESET_SYSTEM ResetSystem;\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
+ 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
- EFI_PEI_FFS_FIND_SECTION_DATA3 FindSectionData3;\r
- EFI_PEI_FFS_GET_FILE_INFO2 FfsGetFileInfo2;\r
- EFI_PEI_RESET2_SYSTEM ResetSystem2;\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
+ EFI_PEI_FFS_FIND_SECTION_DATA3 FindSectionData3;\r
+ EFI_PEI_FFS_GET_FILE_INFO2 FfsGetFileInfo2;\r
+ EFI_PEI_RESET2_SYSTEM ResetSystem2;\r
+ EFI_PEI_FREE_PAGES FreePages;\r
};\r
\r
-\r
///\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
+///\r
typedef struct _EFI_SEC_PEI_HAND_OFF {\r
///\r
/// Size of the data structure.\r
- /// \r
- UINT16 DataSize;\r
+ ///\r
+ UINT16 DataSize;\r
\r
///\r
- /// Points to the first byte of the boot firmware volume, \r
- /// which the PEI Dispatcher should search for \r
+ /// Points to the first byte of the boot firmware volume,\r
+ /// which the PEI Dispatcher should search for\r
/// PEI modules.\r
- /// \r
- VOID *BootFirmwareVolumeBase;\r
+ ///\r
+ VOID *BootFirmwareVolumeBase;\r
\r
///\r
/// Size of the boot firmware volume, in bytes.\r
- /// \r
- UINTN BootFirmwareVolumeSize;\r
+ ///\r
+ UINTN BootFirmwareVolumeSize;\r
\r
///\r
/// Points to the first byte of the temporary RAM.\r
- /// \r
- VOID *TemporaryRamBase;\r
+ ///\r
+ VOID *TemporaryRamBase;\r
\r
///\r
/// Size of the temporary RAM, in bytes.\r
- /// \r
- UINTN TemporaryRamSize;\r
+ ///\r
+ UINTN TemporaryRamSize;\r
\r
///\r
- /// Points to the first byte of the temporary RAM \r
- /// available for use by the PEI Foundation. The area \r
- /// described by PeiTemporaryRamBase and PeiTemporaryRamSize \r
+ /// Points to the first byte of the temporary RAM\r
+ /// available for use by the PEI Foundation. The area\r
+ /// described by PeiTemporaryRamBase and PeiTemporaryRamSize\r
/// must not extend outside beyond the area described by\r
/// TemporaryRamBase & TemporaryRamSize. This area should not\r
- /// overlap with the area reported by StackBase and \r
+ /// overlap with the area reported by StackBase and\r
/// StackSize.\r
///\r
- VOID *PeiTemporaryRamBase;\r
+ VOID *PeiTemporaryRamBase;\r
\r
///\r
- /// The 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
+ UINTN PeiTemporaryRamSize;\r
\r
///\r
- /// Points to the first byte of the stack. \r
- /// This are may be part of the memory described by \r
- /// TemporaryRamBase and TemporaryRamSize \r
+ /// Points to the first byte of the stack.\r
+ /// This are may be part of the memory described by\r
+ /// TemporaryRamBase and TemporaryRamSize\r
/// or may be an entirely separate area.\r
- /// \r
- VOID *StackBase;\r
+ ///\r
+ VOID *StackBase;\r
\r
///\r
/// Size of the stack, in bytes.\r
- /// \r
- UINTN StackSize;\r
+ ///\r
+ UINTN StackSize;\r
} EFI_SEC_PEI_HAND_OFF;\r
\r
-\r
/**\r
The entry point of PEI Foundation.\r
\r
allows the SEC phase to pass information about the stack,\r
temporary RAM and the Boot Firmware Volume. In addition, it also\r
allows the SEC phase to pass services and data forward for use\r
- during the PEI phase in the form of one or more PPIs. There is\r
- no limit to the number of additional PPIs that can be passed\r
- from SEC into the PEI Foundation. As part of its initialization\r
- phase, the PEI Foundation will add these SEC-hosted PPIs to its\r
- PPI database such that both the PEI Foundation and any modules\r
- can leverage the associated service calls and/or code in these\r
- early PPIs.\r
+ during the PEI phase in the form of one or more PPIs. These PPI's\r
+ will be installed and/or immediately signaled if they are\r
+ notification type. There is no limit to the number of additional\r
+ PPIs that can be passed from SEC into the PEI Foundation. As part\r
+ of its initialization phase, the PEI Foundation will add these\r
+ SEC-hosted PPIs to its PPI database such that both the PEI\r
+ Foundation and any modules can leverage the associated service\r
+ calls and/or code in these early PPIs.\r
\r
@param SecCoreData Points to a data structure containing\r
information about the PEI core's\r
(EFIAPI *EFI_PEI_CORE_ENTRY_POINT)(\r
IN CONST EFI_SEC_PEI_HAND_OFF *SecCoreData,\r
IN CONST EFI_PEI_PPI_DESCRIPTOR *PpiList\r
-);\r
+ );\r
\r
#endif\r