\r
\r
/**\r
- Image entry point of Peim.\r
+ The entry point of PE/COFF Image for a PEIM.\r
+\r
+ This function is the entry point for a PEIM. This function must call ProcessLibraryConstructorList() \r
+ and ProcessModuleEntryPointList(). The return value from ProcessModuleEntryPointList() is returned.\r
+ If _gPeimRevision is not zero and PeiServices->Hdr.Revision is less than _gPeimRevison, then ASSERT().\r
\r
@param FileHandle Handle of the file being invoked. \r
- Type EFI_PEI_FILE_HANDLE is defined in FfsFindNextFile().\r
@param PeiServices Describes the list of possible PEI Services.\r
\r
@retval EFI_SUCCESS The PEIM executed normally.\r
\r
/**\r
Required by the EBC compiler and identical in functionality to _ModuleEntryPoint().\r
+ \r
+ This function is required to call _ModuleEntryPoint() passing in FileHandle and PeiServices.\r
\r
@param FileHandle Handle of the file being invoked. \r
- Type EFI_PEI_FILE_HANDLE is defined in FfsFindNextFile().\r
@param PeiServices Describes the list of possible PEI Services.\r
\r
@retval EFI_SUCCESS The PEIM executed normally.\r
IN CONST EFI_PEI_SERVICES **PeiServices\r
);\r
\r
-\r
/**\r
- Call constructs for all libraries. Automatics Generated by tool.\r
+ Autogenerated function that calls the library constructors for all of the module's\r
+ dependent libraries.\r
\r
- @param FileHandle Handle of the file being invoked. \r
- Type EFI_PEI_FILE_HANDLE is defined in FfsFindNextFile().\r
- @param PeiServices Describes the list of possible PEI Services.\r
+ This function must be called by the PEI Core once an initial PEI Services Table has been established.\r
+ This function calls the set of library constructors for the set of library instances that a\r
+ module depends on. This include library instances that a module depends on directly and library\r
+ instances that a module depends on indirectly through other libraries. \r
+ This function is autogenerated by build tools and those build tools are responsible for collecting\r
+ the set of library instances, determine which ones have constructors, and calling the library\r
+ constructors in the proper order based upon each of the library instances own dependencies.\r
+\r
+ @param FileHandle Handle of the file being invoked.\r
+ @param PeiServices Describes the list of possible PEI Services.\r
\r
**/\r
VOID\r
IN CONST EFI_PEI_SERVICES **PeiServices\r
);\r
\r
-\r
/**\r
- Call destructors for all libraries. Automatics Generated by tool.\r
-\r
- @param FileHandle Handle of the file being invoked. \r
- Type EFI_PEI_FILE_HANDLE is defined in FfsFindNextFile().\r
- @param PeiServices Describes the list of possible PEI Services.\r
+ Autogenerated function that calls a set of module entry points.\r
\r
-**/\r
-VOID\r
-EFIAPI\r
-ProcessLibraryDestructorList (\r
- IN EFI_PEI_FILE_HANDLE FileHandle,\r
- IN CONST EFI_PEI_SERVICES **PeiServices\r
- );\r
-\r
-\r
-/**\r
- Call the list of driver entry points. Automatics Generated by tool.\r
+ This function must be called by _ModuleEntryPoint().\r
+ This function calls the set of module entry points. \r
+ This function is autogenerated by build tools and those build tools are responsible\r
+ for collecting the module entry points and calling them in a specified order.\r
\r
@param FileHandle Handle of the file being invoked. \r
- Type EFI_PEI_FILE_HANDLE is defined in FfsFindNextFile().\r
@param PeiServices Describes the list of possible PEI Services.\r
\r
@retval EFI_SUCCESS The PEIM executed normally.\r