From 718715141abc0253f369ca55cce3b69c82913ee2 Mon Sep 17 00:00:00 2001 From: jji4 Date: Wed, 26 Nov 2008 04:36:05 +0000 Subject: Function headers in .h and .c files synchronized with spec git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6728 6f19259b-4bc3-4df7-8a09-765794883524 --- .../Library/PeiCoreEntryPoint/PeiCoreEntryPoint.c | 82 +++++++++++----------- 1 file changed, 41 insertions(+), 41 deletions(-) (limited to 'MdePkg/Library/PeiCoreEntryPoint/PeiCoreEntryPoint.c') diff --git a/MdePkg/Library/PeiCoreEntryPoint/PeiCoreEntryPoint.c b/MdePkg/Library/PeiCoreEntryPoint/PeiCoreEntryPoint.c index 6b9f12d12f..a5c3417c5e 100644 --- a/MdePkg/Library/PeiCoreEntryPoint/PeiCoreEntryPoint.c +++ b/MdePkg/Library/PeiCoreEntryPoint/PeiCoreEntryPoint.c @@ -23,27 +23,33 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. #include /** + The entry point of PE/COFF Image for the PEI Core. - Enrty point to PEI core. - - @param SecCoreData Points to a data structure containing - information about the PEI core's - operating environment, such as the size - and location of temporary RAM, the stack - location and the BFV location. The type - EFI_SEC_PEI_HAND_OFF is - - @param PpiList Points to a list of one or more PPI - descriptors to be installed initially by - the PEI core. An empty PPI list consists - of a single descriptor with the end-tag - EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST. - As part of its initialization phase, the - PEI Foundation will add these SEC-hosted - PPIs to its PPI database such that both - the PEI Foundation and any modules can - leverage the associated service calls - and/or code in these early PPIs. + This function is the entry point for the PEI Foundation, which allows the SEC phase + to pass information about the stack, temporary RAM and the Boot Firmware Volume. + In addition, it also allows the SEC phase to pass services and data forward for use + during the PEI phase in the form of one or more PPIs. + There is no limit to the number of additional PPIs that can be passed from SEC into + the PEI Foundation. As part of its initialization phase, the PEI Foundation will add + these SEC-hosted PPIs to its PPI database such that both the PEI Foundation and any + modules can leverage the associated service calls and/or code in these early PPIs. + This function is required to call ProcessModuleEntryPointList() with the Context + parameter set to NULL. ProcessModuleEntryPoint() is never expected to return. + The PEI Core is responsible for calling ProcessLibraryConstructorList() as soon as + the PEI Services Table and the file handle for the PEI Core itself have been established. + If ProcessModuleEntryPointList() returns, then ASSERT() and halt the system. + + @param SecCoreData Points to a data structure containing information about the PEI + core's operating environment, such as the size and location of + temporary RAM, the stack location and the BFV location. + + @param PpiList Points to a list of one or more PPI descriptors to be installed + initially by the PEI core. An empty PPI list consists of a single + descriptor with the end-tag EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST. + As part of its initialization phase, the PEI Foundation will add + these SEC-hosted PPIs to its PPI database such that both the PEI + Foundation and any modules can leverage the associated service calls + and/or code in these early PPIs. **/ VOID @@ -64,27 +70,21 @@ _ModuleEntryPoint( /** - - Wrapper of enrty point to PEI core. - - @param SecCoreData Points to a data structure containing - information about the PEI core's - operating environment, such as the size - and location of temporary RAM, the stack - location and the BFV location. The type - EFI_SEC_PEI_HAND_OFF is - - @param PpiList Points to a list of one or more PPI - descriptors to be installed initially by - the PEI core. An empty PPI list consists - of a single descriptor with the end-tag - EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST. - As part of its initialization phase, the - PEI Foundation will add these SEC-hosted - PPIs to its PPI database such that both - the PEI Foundation and any modules can - leverage the associated service calls - and/or code in these early PPIs. + Required by the EBC compiler and identical in functionality to _ModuleEntryPoint(). + + This function is required to call _ModuleEntryPoint() passing in SecCoreData and PpiList. + + @param SecCoreData Points to a data structure containing information about the PEI core's + operating environment, such as the size and location of temporary RAM, + the stack location and the BFV location. + + @param PpiList Points to a list of one or more PPI descriptors to be installed + initially by the PEI core. An empty PPI list consists of a single + descriptor with the end-tag EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST. + As part of its initialization phase, the PEI Foundation will add these + SEC-hosted PPIs to its PPI database such that both the PEI Foundation + and any modules can leverage the associated service calls and/or code + in these early PPIs. **/ VOID -- cgit v1.2.3