/** @file\r
- Entry point to a PEIM\r
+ Module entry point library for PEIM.\r
\r
-Copyright (c) 2006, Intel Corporation<BR>\r
+Copyright (c) 2006 - 2008 Intel Corporation<BR>\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
/**\r
Image entry point of Peim.\r
\r
- @param FfsHeader Pointer to FFS header the loaded driver.\r
- @param PeiServices Pointer to the PEI services.\r
-\r
- @return Status returned by entry points of Peims.\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
+ @retval !EFI_SUCCESS The PEIM failed to execute normally.\r
**/\r
EFI_STATUS\r
EFIAPI\r
\r
\r
/**\r
- Wrapper of Peim image entry point.\r
+ Required by the EBC compiler and identical in functionality to _ModuleEntryPoint().\r
\r
- @param FfsHeader Pointer to FFS header the loaded driver.\r
- @param PeiServices Pointer to the PEI services.\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
- @return Status returned by entry points of Peims.\r
+ @retval EFI_SUCCESS The PEIM executed normally.\r
+ @retval !EFI_SUCCESS The PEIM failed to execute normally.\r
\r
**/\r
EFI_STATUS\r
/**\r
Call constructs for all libraries. Automatics Generated by tool.\r
\r
- @param FfsHeader Pointer to FFS header the loaded driver.\r
- @param PeiServices Pointer to the PEI services.\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
**/\r
VOID\r
/**\r
Call destructors for all libraries. Automatics Generated by tool.\r
\r
- @param FfsHeader Pointer to FFS header the loaded driver.\r
- @param PeiServices Pointer to the PEI services.\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
**/\r
VOID\r
/**\r
Call the list of driver entry points. Automatics Generated by tool.\r
\r
- @param FfsHeader Pointer to FFS header the loaded driver.\r
- @param PeiServices Pointer to the PEI services.\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
- @return Status returned by entry points of drivers. \r
+ @retval EFI_SUCCESS The PEIM executed normally.\r
+ @retval !EFI_SUCCESS The PEIM failed to execute normally.\r
\r
**/\r
EFI_STATUS\r