summaryrefslogtreecommitdiff
path: root/MdePkg/Library/DxeCoreEntryPoint
diff options
context:
space:
mode:
authorklu2 <klu2@6f19259b-4bc3-4df7-8a09-765794883524>2008-12-10 03:14:49 +0000
committerklu2 <klu2@6f19259b-4bc3-4df7-8a09-765794883524>2008-12-10 03:14:49 +0000
commit518db1d9e02c74955b5c96351c0d0ec1b58430ae (patch)
tree31efff35129e54dc0d1064ee3412b6cb79f54eb0 /MdePkg/Library/DxeCoreEntryPoint
parentf38fdc749879ff6b9339fded2062e3dac46fa72d (diff)
downloadedk2-platforms-518db1d9e02c74955b5c96351c0d0ec1b58430ae.tar.xz
Synchronize interface function comment from declaration in library class header file to implementation in library instance.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6952 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdePkg/Library/DxeCoreEntryPoint')
-rw-r--r--MdePkg/Library/DxeCoreEntryPoint/DxeCoreEntryPoint.c35
1 files changed, 14 insertions, 21 deletions
diff --git a/MdePkg/Library/DxeCoreEntryPoint/DxeCoreEntryPoint.c b/MdePkg/Library/DxeCoreEntryPoint/DxeCoreEntryPoint.c
index f2f30d6940..fba0c24249 100644
--- a/MdePkg/Library/DxeCoreEntryPoint/DxeCoreEntryPoint.c
+++ b/MdePkg/Library/DxeCoreEntryPoint/DxeCoreEntryPoint.c
@@ -26,25 +26,16 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
VOID *gHobList = NULL;
/**
- Entry point to DXE core.
-
- This function is the entry point to the DXE Foundation. The PEI phase, which executes just before
- DXE, is responsible for loading and invoking the DXE Foundation in system memory. The only
- parameter that is passed to the DXE Foundation is HobStart. This parameter is a pointer to the
- HOB list that describes the system state at the hand-off to the DXE Foundation. At a minimum,
- this system state must include the following:
- - PHIT HOB
- - CPU HOB
- - Description of system memory
- - Description of one or more firmware volumes
- The DXE Foundation is also guaranteed that only one processor is running and that the processor is
- running with interrupts disabled. The implementation of the DXE Foundation must not make any
- assumptions about where the DXE Foundation will be loaded or where the stack is located. In
- general, the DXE Foundation should make as few assumptions about the state of the system as
- possible. This lack of assumptions will allow the DXE Foundation to be portable to the widest
- variety of system architectures.
-
- @param HobStart Pointer of HobList.
+ The entry point of PE/COFF Image for the DXE Core.
+
+ This function is the entry point for the DXE Core. This function is required
+ to call ProcessModuleEntryPointList() and ProcessModuleEntryPoint() is never
+ expected to return. The DXE Core is responsible for calling ProcessLibraryConstructorList()
+ as soon as the EFI System Table and the image handle for the DXE Core itself have
+ been established.
+ If ProcessModuleEntryPointList() returns, then ASSERT() and halt the system.
+
+ @param HobStart Pointer to the beginning of the HOB List passed in from the PEI Phase.
**/
VOID
@@ -72,9 +63,11 @@ _ModuleEntryPoint (
/**
- Wrapper of entry point to DXE CORE.
+ Required by the EBC compiler and identical in functionality to _ModuleEntryPoint().
+
+ This function is required to call _ModuleEntryPoint() passing in HobStart.
- @param HobStart Pointer of HobList.
+ @param HobStart Pointer to the beginning of the HOB List passed in from the PEI Phase.
**/
VOID