/** @file\r
- Entry point to a UEFI Application.\r
+ Module entry point library for UEFI Applications.\r
\r
-Copyright (c) 2007, Intel Corporation<BR>\r
+Copyright (c) 2007 - 2008, Intel Corporation\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
/// Declare the EFI/UEFI Specification Revision to which this driver is implemented \r
///\r
-extern const UINT32 _gUefiDriverRevision;\r
+extern CONST UINT32 _gUefiDriverRevision;\r
+\r
\r
/**\r
Enrty point to UEFI Application.\r
\r
- @param ImageHandle ImageHandle of the loaded driver.\r
- @param SystemTable Pointer to the EFI System Table.\r
+ This function is the entry point for a UEFI Application. This function must call\r
+ ProcessLibraryConstructorList(), ProcessModuleEntryPointList(), and ProcessLibraryDestructorList().\r
+ The return value from ProcessModuleEntryPointList() is returned.\r
+ If _gUefiDriverRevision is not zero and SystemTable->Hdr.Revision is less than _gUefiDriverRevison,\r
+ then return EFI_INCOMPATIBLE_VERSION.\r
+\r
+ @param ImageHandle The image handle of the UEFI Application.\r
+ @param SystemTable A pointer to the EFI System Table.\r
\r
- @retval EFI_SUCCESS One or more of the drivers returned a success code.\r
- @retval !EFI_SUCESS The return status from the last driver entry point in the list.\r
+ @retval EFI_SUCCESS The UEFI Application exited normally.\r
+ @retval EFI_INCOMPATIBLE_VERSION _gUefiDriverRevision is greater than SystemTable->Hdr.Revision.\r
+ @retval Other Return value from ProcessModuleEntryPointList().\r
\r
**/\r
EFI_STATUS\r
\r
\r
/**\r
- Enrty point wrapper of UEFI Application.\r
+ Required by the EBC compiler and identical in functionality to _ModuleEntryPoint(). \r
\r
- @param ImageHandle ImageHandle of the loaded driver.\r
- @param SystemTable Pointer to the EFI System Table.\r
+ @param ImageHandle The image handle of the UEFI Application.\r
+ @param SystemTable A pointer to the EFI System Table.\r
\r
- @retval EFI_SUCCESS One or more of the drivers returned a success code.\r
- @retval !EFI_SUCESS The return status from the last driver entry point in the list.\r
+ @retval EFI_SUCCESS The UEFI Application exited normally.\r
+ @retval EFI_INCOMPATIBLE_VERSION _gUefiDriverRevision is greater than SystemTable->Hdr.Revision.\r
+ @retval Other Return value from ProcessModuleEntryPointList().\r
\r
**/\r
EFI_STATUS\r
\r
\r
/**\r
- Invoke the destuctors of all libraries and call gBS->Exit\r
- to return control to firmware core.\r
+ Invokes the library destructors for all dependent libraries and terminates\r
+ the UEFI Application. \r
\r
- @param Status Status returned by the application that is exiting.\r
+ This function calls ProcessLibraryDestructorList() and the EFI Boot Service Exit()\r
+ with a status specified by Status.\r
+\r
+ @param Status Status returned by the application that is exiting.\r
\r
**/\r
VOID\r
\r
\r
/**\r
- Call constructors for all libraries. Autogen tool inserts the implementation\r
- of this function into Autogen.c.\r
-\r
- @param ImageHandle ImageHandle of the loaded driver.\r
- @param SystemTable Pointer to the EFI System Table.\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\r
+ that a module depends on. This includes library instances that a module depends on\r
+ directly and library 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\r
+ collecting the set of library instances, determine which ones have constructors, and\r
+ calling the library constructors in the proper order based upon each of the library\r
+ instances own dependencies.\r
+\r
+ @param ImageHandle The image handle of the UEFI Application.\r
+ @param SystemTable A pointer to the EFI System Table.\r
\r
**/\r
VOID\r
\r
\r
/**\r
- Call destructors for all libraries. Autogen tool inserts the implementation\r
- of this function into Autogen.c.\r
+ Autogenerated function that calls the library descructors for all of the module's\r
+ dependent libraries.\r
\r
- @param ImageHandle ImageHandle of the loaded driver.\r
- @param SystemTable Pointer to the EFI System Table.\r
+ This function may be called by _ModuleEntryPoint()or Exit().\r
+ This function calls the set of library destructors for the set of library instances\r
+ that a module depends on. This includes library instances that a module depends on\r
+ directly and library instances that a module depends on indirectly through other libraries. \r
+ This function is autogenerated by build tools and those build tools are responsible\r
+ for collecting the set of library instances, determine which ones have destructors,\r
+ and calling the library destructors in the proper order based upon each of the library\r
+ instances own dependencies.\r
+\r
+ @param ImageHandle The image handle of the UEFI Application.\r
+ @param SystemTable A pointer to the EFI System Table.\r
\r
**/\r
VOID\r
);\r
\r
/**\r
- Call driver entry point. For UEFI application, user\r
- can only specify one entry point. Tool will automatically insert\r
- this to Autogen.c.\r
+ This function calls the set of module entry points. It must be called by _ModuleEntryPoint().\r
+\r
+ This function is autogenerated by build tools and those build tools are \r
+ responsible for collecting the module entry points and calling them in a specified order.\r
+\r
+ @param ImageHandle The image handle of the UEFI Application.\r
+ @param SystemTable A pointer to the EFI System Table.\r
\r
- @param ImageHandle ImageHandle of the loaded driver.\r
- @param SystemTable Pointer to the EFI System Table.\r
+ @retval EFI_SUCCESS The UEFI Application executed normally.\r
+ @retval !EFI_SUCCESS The UEFI Application failed to execute normally.\r
\r
- @return Status returned by entry points specified by\r
- the user. \r
- \r
**/\r
EFI_STATUS\r
EFIAPI\r
projects / mirror_edk2.git / blobdiff