/** @file\r
- Entry point to a PEIM\r
+ Module entry point library for PEIM.\r
\r
-Copyright (c) 2006, 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
-http://opensource.org/licenses/bsd-license.php\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 - 2018, Intel Corporation. All rights reserved.<BR>\r
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#define __MODULE_ENTRY_POINT_H__\r
\r
///\r
-/// Declare the EFI/UEFI Specification Revision to which this driver is implemented \r
+/// Declare the EFI/UEFI Specification Revision to which this driver is implemented\r
///\r
-extern CONST UINT32 _gPeimRevision;\r
-\r
+extern CONST UINT32 _gPeimRevision;\r
\r
/**\r
- Image entry point of Peim.\r
+ The entry point of PE/COFF Image for a PEIM.\r
\r
- @param FfsHeader Pointer to FFS header the loaded driver.\r
- @param PeiServices Pointer to the PEI services.\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
- @return Status returned by entry points of Peims.\r
+ @param FileHandle Handle of the file being invoked.\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
_ModuleEntryPoint (\r
- IN EFI_PEI_FILE_HANDLE FileHandle,\r
- IN CONST EFI_PEI_SERVICES **PeiServices\r
+ IN EFI_PEI_FILE_HANDLE FileHandle,\r
+ IN CONST EFI_PEI_SERVICES **PeiServices\r
);\r
\r
-\r
/**\r
- Wrapper of Peim image entry point.\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 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
+ @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
EFIAPI\r
EfiMain (\r
- IN EFI_PEI_FILE_HANDLE FileHandle,\r
- IN CONST EFI_PEI_SERVICES **PeiServices\r
+ IN EFI_PEI_FILE_HANDLE FileHandle,\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
+ This function must be called by _ModuleEntryPoint().\r
+ This function calls the set of library constructors for the set of library instances that a\r
+ module depends on. This includes 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 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
+ @param PeiServices Describes the list of possible PEI Services.\r
\r
**/\r
VOID\r
EFIAPI\r
ProcessLibraryConstructorList (\r
- IN EFI_PEI_FILE_HANDLE FileHandle,\r
- IN CONST EFI_PEI_SERVICES **PeiServices\r
+ IN EFI_PEI_FILE_HANDLE FileHandle,\r
+ IN CONST EFI_PEI_SERVICES **PeiServices\r
);\r
\r
-\r
/**\r
- Call destructors for all libraries. Automatics Generated by tool.\r
+ Autogenerated function that calls a set of module entry points.\r
\r
- @param FfsHeader Pointer to FFS header the loaded driver.\r
- @param PeiServices Pointer to the PEI services.\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
-**/\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
+ @param FileHandle Handle of the file being invoked.\r
+ @param PeiServices Describes the list of possible PEI Services.\r
\r
- @param FfsHeader Pointer to FFS header the loaded driver.\r
- @param PeiServices Pointer to the PEI services.\r
+ @retval EFI_SUCCESS The PEIM executed normally.\r
+ @retval !EFI_SUCCESS The PEIM failed to execute normally.\r
\r
- @return Status returned by entry points of drivers. \r
- \r
**/\r
EFI_STATUS\r
EFIAPI\r
ProcessModuleEntryPointList (\r
- IN EFI_PEI_FILE_HANDLE FileHandle,\r
- IN CONST EFI_PEI_SERVICES **PeiServices\r
+ IN EFI_PEI_FILE_HANDLE FileHandle,\r
+ IN CONST EFI_PEI_SERVICES **PeiServices\r
);\r
\r
#endif\r
projects / mirror_edk2.git / blobdiff