diff options
| author | jji4 <jji4@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-11-26 04:36:05 +0000 |
|---|---|---|
| committer | jji4 <jji4@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-11-26 04:36:05 +0000 |
| commit | 718715141abc0253f369ca55cce3b69c82913ee2 (patch) | |
| tree | 019211862f4e6f7b3d68153461d222fd6cfaf668 /MdePkg/Library/UefiApplicationEntryPoint | |
| parent | 3e5c323866e6f424f15ab7f59595d8929846354e (diff) | |
| download | edk2-718715141abc0253f369ca55cce3b69c82913ee2.tar.gz edk2-718715141abc0253f369ca55cce3b69c82913ee2.tar.bz2 edk2-718715141abc0253f369ca55cce3b69c82913ee2.zip | |
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
Diffstat (limited to 'MdePkg/Library/UefiApplicationEntryPoint')
| -rw-r--r-- | MdePkg/Library/UefiApplicationEntryPoint/ApplicationEntryPoint.c | 39 |
1 files changed, 26 insertions, 13 deletions
diff --git a/MdePkg/Library/UefiApplicationEntryPoint/ApplicationEntryPoint.c b/MdePkg/Library/UefiApplicationEntryPoint/ApplicationEntryPoint.c index c5abc85e70..da1067404d 100644 --- a/MdePkg/Library/UefiApplicationEntryPoint/ApplicationEntryPoint.c +++ b/MdePkg/Library/UefiApplicationEntryPoint/ApplicationEntryPoint.c @@ -18,13 +18,20 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. /**
- Enrty point to UEFI application.
+ Enrty point to UEFI Application.
- @param ImageHandle ImageHandle of the loaded driver.
- @param SystemTable Pointer to the EFI System Table.
+ This function is the entry point for a UEFI Application. This function must call
+ ProcessLibraryConstructorList(), ProcessModuleEntryPointList(), and ProcessLibraryDestructorList().
+ The return value from ProcessModuleEntryPointList() is returned.
+ If _gUefiDriverRevision is not zero and SystemTable->Hdr.Revision is less than _gUefiDriverRevison,
+ then return EFI_INCOMPATIBLE_VERSION.
- @retval EFI_SUCCESS One or more of the drivers returned a success code.
- @retval !EFI_SUCESS The return status from the last driver entry point in the list.
+ @param ImageHandle The image handle of the UEFI Application.
+ @param SystemTable A pointer to the EFI System Table.
+
+ @retval EFI_SUCCESS The UEFI Application exited normally.
+ @retval EFI_INCOMPATIBLE_VERSION _gUefiDriverRevision is greater than SystemTable->Hdr.Revision.
+ @retval Other Return value from ProcessModuleEntryPointList().
**/
EFI_STATUS
@@ -66,11 +73,15 @@ _ModuleEntryPoint ( return Status;
}
+
/**
- Invoke the destuctors of all libraries and call gBS->Exit
- to return control to firmware core.
+ Invokes the library destructors fror all dependent libraries and terminates
+ the UEFI Application.
- @param Status Status returned by the application that is exiting.
+ This function calls ProcessLibraryDestructorList() and the EFI Boot Service Exit()
+ with a status specified by Status.
+
+ @param Status Status returned by the application that is exiting.
**/
VOID
@@ -85,14 +96,16 @@ Exit ( gBS->Exit (gImageHandle, Status, 0, NULL);
}
+
/**
- Enrty point wrapper of UEFI Application.
+ Required by the EBC compiler and identical in functionality to _ModuleEntryPoint().
- @param ImageHandle ImageHandle of the loaded driver.
- @param SystemTable Pointer to the EFI System Table.
+ @param ImageHandle The image handle of the UEFI Application.
+ @param SystemTable A pointer to the EFI System Table.
- @retval EFI_SUCCESS One or more of the drivers returned a success code.
- @retval !EFI_SUCESS The return status from the last driver entry point in the list.
+ @retval EFI_SUCCESS The UEFI Application exited normally.
+ @retval EFI_INCOMPATIBLE_VERSION _gUefiDriverRevision is greater than SystemTable->Hdr.Revision.
+ @retval Other Return value from ProcessModuleEntryPointList().
**/
EFI_STATUS
|